Odyssey File & Serve
EFSP API Reference Guide v2025.3-ECF5

APIs for E-Filing Service Providers

The EFM APIs for E-Filing Service Providers fall into several broad categories:
    Details regarding each of these categories are provided below.


    IMPORTANT NOTES

    • The schema folder consists of the ECF 5 WSDLs which define the messages, bindings, and ports. This folder also contains several Tyler specific WSDLs which define additional operations that are not provided by the ECF specification.
    • The service folder contains Tyler implementation specific WSDLs which imports the WSDLs from the schema folder and Tyler extensions where appropriate. These WSDLs define the service and security policy.
    • The WSDLs without the Tyler prefix are our implementation of ECF 5. That is, they only contain bona-fide ECF 5 operations but might include extension elements. Key point: no non-ECF operations are in these WSDLs. The WSDLs with the Tyler prefix are new operations that Tyler has added to cover functionality needs that ECF does not address.
    • The EFM implementation of ECF does not support the xsi:type attribute in XML; instead, the ECF message should explicitly define the common ECF namespace prefix for the element or define it on the element. Use of the xsi:type attribute can cause parsing to fail, which could result in unknown error messages.
    • CodeIDs used in a test or stage environment will be different than the corresponding code's CodeIDs in production.
    • URLs included herein and in the sample files are for demonstration purposes only. The actual URLs vary by market.
    • While most API calls require that a user provide credentials, several APIs do not require user credentials. For such APIs, the EFSP should take measures to prevent abuse (e.g. use of captcha).

    Configuration

    The EFM configuration includes system codes and court specific codes. Some court specific codes pertain only to the initiation of criminal cases. In order to obtain configuration information, first retrieve the system codes, then the court specific codes. You only need to retrieve criminal initiation specific codes if your system serves a prosecutorial agency and therefore would initiate criminal cases.


    Code retrieval requests are via HTTP GET. All code retrieval responses consist of XML that is ZIP compressed. The response schema for all code retrievals is OASIS Genericode. The code field contains the unique identifier for each code row. Some court specific code tables include additional metadata that provides additional information to drive EFM behavior such as whether a particular code value is valid for a given business scenario.

    Access Control
    Access to the code sets is restricted to authorized systems. In order to authenticate your request, include an HTTP header named tyl-api-auth. The content of this header should be the current timestamp, signed via Cryptographic Message Syntax utilizing the same X.509 certificate that you use to sign your SOAP headers, then base64 encoded. Sample .NET and JAVA code is available here

    Caching
    Due to the high degree of configuration within the system, EFSPs should cache the configuration information for quick, on-demand use. Code caches should be refreshed after 1AM of the local timezone in order to pick up configuration changes for the next day. The CodeVersions code table provides checksums of each code table at each court location, which you can use to determine whether you need to refresh your local copy.

      Details regarding both types of codes are provided below.

      System Codes

      System codes define system wide behaviors and capabilities of the EFM
        Details regarding each set of system codes are provided below.

        Court Locations

        This call retrieves a listing of the court locations currently utilizing the EFM. A court location is not necessarily a physical location, but rather, the entire set of court locations is a representation of the state's court organizational structure.

        The code field contains a unique identifier, referred to as the Court Location Identifier (CLI), which is used within various APIs to specify the particular court location for that invocation of the API. The general naming convention of a CLI includes one or two parts:

        • primary - typically a county or a district
        • secondary - an office, division, or court
        If a secondary part exists, the CLI will be of the form primary:secondary. Examples: "tyler" would represent Tyler County, "tyler:dc" would represent the Tyler County District Clerk, or "tyler:dc101" would represent the Tyler County 101st District Court.

        NOTE: The CLIs between STAGE and PROD sites may differ, although this should be rare and is often times transient.

        This call accepts no input parameters. The actual URL will be provided to you by Tyler when you receive access to each site.

        Version3.7
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/location/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        Court LocationsN/ALocations
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        codeUnique EFM identifier for the code. This field is also known as the Court Location Identifier
        nameTextual description of the code
        initialIndicates whether the location accepts initial/new case filings
        subsequentIndicates whether the location accepts subsequent filings
        disallowcopyingenvelopemultipletimes Indicates whether the location supports the ability to copy an envelope more than once
        allowfilingintononindexedcase Indicates whether the location supports filings into non-indexed cases. Non-indexed cases are cases that exist with the court but are not known to the EFM due to a limited integration with the Clerk's CMS. Non-indexed case filings are submitted similar to a new case filing but the filer also specifies the case number.
        allowablecardtypes A comma delimited list of payment types accepted by the court. Possible values:
        • AMEX
        • CHECKING
        • DISCOVER
        • MASTERCARD
        • VISA
        odysseynodeidIndicates the Odyssey NodeID for a court location that is integrated with Tyler's Odyssey Case Manager
        cmsid Indicates the CMSID - a unique identifier assigned to each instance of a CMS. This is only relevant to court agencies who use the EFM as well as Odyssey Case Manager APIs. This information allows such agencies to use the OdysseyNodeID field in an EFM instance that integrates to multiple Odyssey installations.
        sendservicebeforereviewIndicates whether the EFM will perform e-Service before or after clerk review
        parentnodeidIdentifies the parent court location by providing its code value
        iscountyBoolean to indicate whether this location represents a County
        restrictbankaccountpayment Indicates whether the use of eChecks is restricted to firm users only. When restricted to firm users only, individual users will be unable to submit filings with eChecks and will receive an error 216 - User is restricted from Using eCheck.
        allowmultipleattorneysBoolean to indicate whether this location allows a case party to have more than one attorney
        sendservicecontactremovednotficationsBoolean to indicate whether the EFM will send an email to service contacts when they are detached from a case at this location
        allowmaxfeeamountBoolean to indicate whether this location allows the filer to specify a maximum fee amount to which the reviewer can adjust filings during review
        transferwaivedfeestocmsBoolean to indicate whether the EFM will require a Party Responsible for Fees when a waiver is used at this location
        skippreauthBoolean to indicate whether credit card authorization is disabled
        hasconditionalservicetypes Boolean to indicate whether the available service types are based upon the filing details, thereby overriding the system-wide service contact types
        hasprotectedcasetypes Boolean to indicate that this location has case types that require the EFSP to mask the case category and case type. The specific case types are specified in the hasconditionalservicetypes column
        protectedcasetypes A comma delimited list of case type code ids. For any cases of these case types, the EFSP must mask the case category and case type
        allowzerofeeswithoutfilingparty Boolean to indicate whether the FilingPartyID is required when no fees are due.
        allowserviceoninitial A location specific override to the Data Field Configuration FilingServiceCheckBoxInitial

        • True - Allow service on initial filings at this location
        • False - Do not allow service on initial filings at this location
        • (Empty) - No override in place - use the setting indicated by FilingServiceCheckBoxInitial
        allowaddservicecontactsoninitial Boolean to indicate whether service contacts can be added on initial filings at this location.
        allowredaction Boolean to indicate whether redaction is enabled at this location. Information about integrating with Tyler's document redaction service is available here
        redactionurl The URL for interacting with the redaction service. Information about integrating with Tyler's document redaction service is available here
        redactionviewerurl The URL for launching the redaction viewer/editor. Information about integrating with Tyler's document redaction service is available here
        redactionapiversion The version of the TIS API for courts at which redaction is enabled. Information about integrating with Tyler's document redaction service is available here
        enforceredaction Boolean to indicate whether forced redaction is enabled at this location. Information about integrating with Tyler's document redaction service is available here
        redactiondocumenttype A document type code to indicate the document type (see DocumentTypeCodes) to be included for redacted documents at this location. Information about integrating with Tyler's document redaction service is available here
        defaultdocumentdescription A location specific override to the Data Field Configuration DocumentDescription

        • 1 - Sets the default value to the filing code description (comparable to FilingCode for data field configuration).
        • 2 - Sets the default value to the name of the uploaded file (comparable to FileName for the data field configuration).
        • A NULL value indicates that the field will obey the Data Field Configuration.
        allowwaiveronmail Boolean to indicate whether a waiver account can be used for the mail and certified mail service types at this location.
        showreturnonreject Boolean to indicate whether to use the term "Return" instead of "Reject". If value is True, use the term "Return"
        protectedcasereplacementstring Textual value to use as a replacement for the case category and case type for case types identified by the protectedcasetypes column
        redactionfee Amount that indicates the redaction fee at this location.
        allowwaiveronredaction Boolean to indicate whether or not redaction fees will be waived.
        disallowelectronicserviceonnewcontacts Boolean to indicate that only mail service is allowed for a service contact added to an initial filing.
        allowindividualregistration Boolean to indicate whether or not the system allows an individual to register.
        redactiontargetconfig A comma delimited list of elements to be redacted. Possible values:
        • AccountNumber
        • CreditCard
        • DriversLicense
        • GovernmentID
        • Passport
        • SocialSecurityNumber
        • TaxDocument
        bulkfilingfeeassessorconfiguration Boolean to indicate whether or not the system allows bulk filings
        envelopelevelcommentconfiguration A nullable boolean:
        • Boolean True to indicate an envelope comment is required
        • Boolean False to indicate an envelope comment is not allowed
        • Null to indicate an envelope comment is allowed, but optional
        autoassignsrlservicecontact Boolean to indicate that the system will require self-represented litigants to be a service contact on the case
        When set to true and the filer is a party on the case, the filer must register as a service contact for the case
        autoassignattorneyservicecontact Boolean to indicate that the system will requires attorneys to be a service contact on the case
        When set to true and the GetAttorney API includes an email address (from the state bar feed), the attorney must register as a service contact for the case when filing
        partialwaiverdurationindays The number of days a newly granted standing waiver is valid before expiring
        partialwaivercourtpaymentsystemurl The URL for the court's independent payment system
        partialwaiveravailablewaiverpercentages A list of percentages that maybe be granted for standing waivers
        eserviceconsentenabled Boolean to indicate if consent is needed for eService.
        With this configuration, there are also help texts associated with eService Consent.
        hearingschedulingenabled Boolean to indicate if Ad Hoc Hearings are allowed to be scheduled.
        serviceofprocessenabled Boolean to indicate if Service of Process is available at this location.



        Code Versions

        This call retrieves a listing of checksums for each code table within each court. The EFSP should use the checksum to determine whether a new version of the court's code table is available. System code tables will appear once whereas location specific code tables will appear once per location.
        Version3.15
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/versions/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        Code VersionsN/ACodeVersions
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        locationCourt Location Identifier, as defined in Locations code table
        codelistThe .zip filename of the code table
        versionA value that indicates the checksum for this court location's specified code table



        Error Codes

        This call retrieves a listing of the errors the EFM is capable of generating. This call accepts no input parameters.
        Version3.7
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/error/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        Error CodesN/AErrorCodes
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        codeUnique EFM identifier for the code
        nameTextual description of the code



        Country Codes

        This call retrieves a listing of valid country codes for use with the EFM. This call accepts no input parameters. The actual URL is available through         GetPolicy
        Version3.7
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/country/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        Country CodesN/ACountryCodes
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        codeUnique EFM identifier for the code
        nameTextual description of the code



        State Codes

        This call retrieves a listing of valid state codes for use with the EFM. This call accepts no input parameters. The actual URL is available through         GetPolicy
        Version3.7
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/state/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        State CodesN/AStateCodes
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        codeUnique EFM identifier for the code
        nameTextual description of the code
        countrycodeThe associated country code



        Filing Status Codes

        This call retrieves a listing of valid filing status codes for use with the EFM. This call accepts no input parameters. The actual URL is available through         GetPolicy
        Version3.7
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/filingstatus/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        Filing Status CodesN/AFilingStatusCodes
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        codeUnique EFM identifier for the code
        nameTextual description of the code



        Data Field Configuration Codes

        This call retrieves a listing of site-wide configurations. This call accepts no input parameters. The actual URL is available through         GetPolicy

        There configuration items fall into two categories:

        Version3.10
        RequiredCore functionality
        Sample URLhttps://court.tylertech.cloud/CodeService/codes/datafield/
        Request Message DefinitionN/A
        Response Message Definitiongenericode
        XML Samples
        DescriptionRequestResponse
        Data Field Configuration CodesN/ADataFieldConfigCodes
        Inputs
        FieldDescription
        No Inputs
        Outputs
        FieldDescription
        codeUnique EFM identifier for the code
        nameTextual description of the code
        isvisibleBoolean to indicate whether the site displays the field
        isrequiredBoolean to indicate whether the site requires the field
        helptextMessage that the Odyssey File & Serve UI will provide to the user as help text for this field.
        ghosttextThe ghost text value that the Odyssey File & Serve UI will provide to the user
        contextualhelpdataThe context sensitive help information that the Odyssey File & Serve UI will provide to the user
        validationmessageError message that the Odyssey File & Serve UI will give when the user provides an invalid value for the field
        regularexpressionRegEx that the EFM will use to perform field validation
        defaultvalueexpressionProvides a tokenized value for defaulting the value of the field
        isreadonlyIndicates that the field is read-only and therefore will result in an error if a value is passed in

        Configurations: All Filing Types

        Configuration Item Purpose
        AdvancedSearchLocationAllLocations Indicates whether the GetCaseList API can be invoked to perform a case search at the System Location in order to search all court locations. This option will only be available for a site that is backed by a single Courts/Clerks Case Management System.

        • When IsVisible=True, indicates that a case search across all locations is available
        • When IsVisible=False, indicates that a case search across all locations is not available
        • If not defined, defaults to IsVisible=False
        CaseAllowAddNewServiceContacts Provides requirements to indicate whether the filer should be allowed to add a new service contact before submitting the filing:

        • When IsVisible=True, indicates that the functionality should be made available to the filer
        • When IsVisible=False, indicates that the functionality should not be made available to the filer
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationCaseSubType Provides requirements regarding the case sub type field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationLowerCourt Provides requirements regarding the case information lower court field. This codified field is used for legacy Appellate case filings instead of the textual CaseInformationLowerCourtName field.

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationLowerCourtCaseJudge Provides requirements regarding the lower court judge name field.

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationLowerCourtCaseNumber Provides requirements regarding the lower court case number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationLowerCourtCaseStyle Provides requirements regarding lower court case style/title field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationLowerCourtName Provides requirements regarding lower court name field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationOtherCaseNumber Provides requirements regarding lower court agency case number information. This field is used for legacy Appellate case filings rather than the CaseInformationLowerCourtCaseNumber field.

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseInformationShortTitle Provides requirements regarding the short title field. This field is used for legacy Appellate case filings rather than the CaseInformationLowerCourtCaseStyle field.

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseSummaryViewAllowAddPublicServiceContacts Provides requirements to indicate whether the filer should be allowed to add a public service contact to the filing:

        • When IsVisible=True, indicates that the functionality should be made available to the filer
        • When IsVisible=False, indicates that the functionality should not be made available to the filer
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseSummaryViewAllowSavePublicServiceContacts Provides requirements to indicate whether the filer should be allowed to save a public service contact before submitting the filing:

        • When IsVisible=True, indicates that the functionality should be made available to the filer
        • When IsVisible=False, indicates that the functionality should not be made available to the filer
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CivilCaseDamageAmountInitial Provides requirements to indicate whether the filer should be able to enter the damage or claim amount on an initial civil filing:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CivilCaseDamageAmountSubsequent Provides requirements regarding the damage or claim amount field on a subsequent civil filing:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CivilCaseProcedureViewInitial Provides requirements regarding the procedure or remedy view on an initial civil filing:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CivilCaseProcedureViewSubsequent Provides requirements regarding the procedure or remedy view on a subsequent civil filing:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        DamageAmount Provides help content regarding the damage amount field.

        DateOfDeath Provides help content regarding the date of death field for configured party types on specified case types.

        DocumentDescription Provides requirements regarding the document description field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • When DefaultValueExpression={{FileName}}, default the document description to document's file name When DefaultValueExpression={{FilingCodeDescription}}, default the document description to the filing code description
        • When IsReadOnly=True, indicates that the field should be made read-only
        • If not defined, defaults to IsVisible=False, IsRequired=False
        • If a RegEx is supplied, it will be used for validating contents of the field
        DocumentType Provides requirements regarding the document type/security field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        DueDateAvailableForFilers Provides requirements regarding the filing due date field (DocumentInformationCutOffDate):

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        FilingEventCaseParties Provides requirements regarding the association of parties to filings:

        • When IsVisible=True, indicates that the party to filing association UI should be visible to the filer
        • When IsVisible=False, indicates that the party to filing association UI should not be visible to the filer
        • When IsRequired=True, indicates that the filer must indicate associations
        • When IsRequired=False, indicates that the filer may indicate associations
        • If not defined, defaults to IsVisible=True, IsRequired=False
        FilingFilerType Provides requirements regarding the filer type field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        FilingFilingAttorneyView Provides requirements regarding the filing attorney field:

        • When IsVisible=True, indicates that the field should be made available to firm users
        • When IsVisible=False, indicates that the field should not be made available to firm users
        • When IsRequired=True, indicates that a firm user must provide a filing attorney
        • When IsRequired=False, indicates that a firm user is not required to provide a filing attorney
        • If not defined, defaults to IsRequired=False
        FilingFilingComments Provides requirements regarding the filing comments field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=True, IsRequired=False
        • If a RegEx is supplied, it will be used for validating contents of the field
        FilingFilingDescription Provides requirements regarding the filing description field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsRequired=False
        • If a RegEx is supplied, it will be used for validating contents of the field
        FilingMotionType Provides requirements regarding motion types:

        • When IsVisible=True, motion type should be available to the filer.
        • When IsVisible=False, motion type should not be available to the filer.
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        FilingReferenceNumber Provides requirements regarding reference numbers:

        • When IsVisible=True, reference number can be included with an initial filing.
        • When IsVisible=False, reference number cannot be included with an initial filing.
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        FilingServiceCheckBoxInitial Provides requirements regarding service on initial filings:

        • When IsVisible=True, service can be included with an initial filing.
        • When IsVisible=False, service cannot be included with an initial filing.
        • If not defined, defaults to IsVisible=False
        FilingServiceCheckBoxSubsequent Provides requirements regarding service on subsequent filings:

        • When IsVisible=True, service can be included with a subsequent filing.
        • When IsVisible=False, service cannot be included with a subsequent filing.
        • If not defined, defaults to IsVisible=False
        GlobalAttorneyNumber Provides requirements regarding Attorney Number in Firm Administration Registration.

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsRequired=False
        • If a RegEx is supplied, it will be used for validating contents of the field
        GlobalAttorneyNumberVerifyButton Provides requirements regarding the bar number field for attorneys:

        • When IsVisible=True, the system will validate the bar number.
        • When IsVisible=False, the system will not validate the bar number.
        • If not defined, defaults to IsVisible=True
        GlobalPassword Provides the regular expression that the system will use to validate password complexity requirements
        LegacyLocationCaseSearch Provides requirements regarding restricting search location to only those locations which allow initial filings

        • When IsVisible=True, only locations which allow initial filings will be allowed.
        • When IsVisible=False, locations that allow initial or subsequent filings will be allowed.
        • If not defined, defaults to IsVisible=False
        OptionalServicesMultipleCopies Provides the regular expression that the system will be used to enforce the maximum number of copies
        OriginalFileName Imposes restrictions on the filename of documents provided by the filer

        • If a RegEx is supplied, it will be used for validating contents of the field
        • If not defined, the filename is restricted to a maximum length of 50 characters
        PartyAddAnotherPartyButtonSubsequent Provides requirements regarding adding new parties to existing cases via subsequent filings:

        • When IsVisible=True, filers are allowed to add new parties to existing cases via subsequent filings.
        • When IsVisible=False, filers are not allowed to add new parties to existing cases via subsequent filings.
        • If not defined, defaults to IsVisible=True
        PartyAttorney Provides requirements regarding attorney associated to a party:

        • When IsVisible=True, attorney field is visible next to party.
        • When IsVisible=False, attorney field is hidden.
        • If not defined, defaults to IsVisible=True
        PartyBusinessName Provides requirements regarding the name of a business that is a case party:

        • The field is restricted to a maximum length of 400 characters but the RegEx can be used to apply additional validations
        PartyDLNumber Provides requirements regarding the driver license number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyDLState Provides requirements regarding the driver license state field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyDLType Provides requirements regarding the driver license type field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyFilerID Provides requirements regarding the FilerID of a case party:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyFirstName Provides requirements regarding the first name of a person who is a case party:

        • The field is restricted to a maximum length of 100 characters but the RegEx can be used to apply additional validations
        PartyGender Provides requirements regarding the gender field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=True, IsRequired=False
        PartyInterpreter Provides requirements regarding the interpreter field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=True, IsRequired=False
        PartyLastName Provides requirements regarding the last name of a person who is a case party:

        • The field is restricted to a maximum length of 100 characters but the RegEx can be used to apply additional validations
        PartyMiddleName Provides requirements regarding the middle name of a person who is a case party:

        • The field is restricted to a maximum length of 100 characters but the RegEx can be used to apply additional validations
        PartyNameSuffix Provides requirements regarding the party name suffix field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyPhone Provides requirements regarding the party phone number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=True, IsRequired=False
        PartySSN Provides requirements regarding the Social Security Number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PublicServiceContactShowEmail Provides requirements regarding the protection of the service contact email address when providing results from the GetPublicList API:

        • When IsVisible=True, the email address may be freely displayed.
        • When IsVisible=False, the email address must not be displayed in a manner that allows programmatic harvesting of the email address.
        • If not defined, defaults to IsVisible=True
        PublicServiceContactShowFreeFormFirmName Provides requirements regarding the firm name to display when providing results from the GetPublicList API:

        • When IsVisible=True, display the FirmName value
        • When IsVisible=False, display the AddByFirmName value
        • If not defined, defaults to IsVisible=False
        SearchLocationFilter Provides requirements regarding whether a court location is required when performing a case search:

        • When IsRequired=True, a court location must be provided
        • When IsRequired=False, a couert location is not required
        • If not defined, a court location must be provided
        ServiceContactEmailAddress Provides requirements regarding the email address field on service contacts:

        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults IsRequired=False; however, either an email address or a postal address must be provided
        ServiceContactIsContactSavedToFirmList Indicates the default behavior the EFSP should use when saving service contacts:

        • When DefaultValueExpression=True, indicates that the default should be to save the service contact to the firm master list
        • When DefaultValueExpression=False, indicates that the default should be to NOT save the service contact to the firm master list
        • If not defined, defaults to DefaultValueExpression=True
        ServiceContactIsPublic Indicates whether users have the ability to add/update entries within the public list of service contacts:

        • When IsVisible=True, indicates that filers can alter the public list
        • When IsVisible=False, indicates that filers cannot alter the public list
        • If not defined, defaults to IsVisible=False
        ServiceContactPhoneNumber Provides requirements for the phone number field on service contacts:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=True, IsRequired=False
        ServiceContacts.ShowAttachedCasesList Provides requirements to indicate whether the filer should be allowed to view attached cases for service contacts:

        • When IsVisible=True, indicates that the functionality should be made available to the filer
        • When IsVisible=False, indicates that the functionality should not be made available to the filer
        • If not defined, defaults to IsVisible=True, IsRequired=False
        ServiceContactStreetAddress Provides requirements for the postal address fields on service contacts:

        • When IsRequired=True, indicates that the fields are required
        • When IsRequired=False, indicates that the fields are optional
        • If not defined, defaults to IsRequired=False; however, either an email address or a postal address must be provided
        ShowSearchTypeChoice Provides requirements to indicate whether the filer should be allowed to view search type choices.

        • When IsVisible=True, indicates that the functionality should be made available to the filer
        • When IsVisible=False, indicates that the functionality should not be made available to the filer
        • If not defined, defaults to IsVisible=True, IsRequired=False
        ShowServiceContactsInSearchResults Provides requirements to indicate whether the filer should be allowed to view service contacts.

        • When IsVisible=True, indicates that the functionality should be made available to the filer
        • When IsVisible=False, indicates that the functionality should not be made available to the filer
        • If not defined, defaults to IsVisible=True, IsRequired=False
        WillFiledDate Provides requirements for the Will Filed Date field on specified case types.

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=True, IsRequired=False

        Configurations: Criminal Initiations

        Configuration Item Purpose
        CaseChargeArrestDate Provides requirements regarding the arrest date field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeArrestLocation Provides requirements regarding the arrest location field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeArrestNumber Provides requirements regarding the arrest number field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeBadgeNumber Provides requirements regarding the badge number field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeBondAmount Provides requirements regarding the bond amount field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeBondType Provides requirements regarding the bond type field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeDateOfOffense Provides requirements regarding the date of offense field for a charge (or the start date for a date range):

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeDateOfOffenseTo Provides requirements regarding the end date field for an offense date range for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeDegree Provides requirements regarding the degree field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeLawEnforcementUnit Provides requirements regarding the law enforcement unit field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeOffense Provides requirements regarding the statute code field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeOffenseCharacter Provides requirements regarding the general offense code field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeOffenseDescription Provides requirements regarding the offense description field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeOffenseTime Provides requirements regarding the offense time field for a charge (or a start time for a time range):

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeOffenseTimeTo Provides requirements regarding the end time field for an offense time range for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargePhase Provides requirements regarding the charge phase field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeProcessControlNumber Provides requirements regarding the process control number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeSequenceNumber Provides requirements regarding the charge sequence number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeStatute Provides requirements regarding the free text charge statute field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeStatuteDegree Provides requirements regarding the statute degree field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeStatuteDescription Provides requirements regarding the statute description field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
          • x`
        CaseChargeStatuteOffense Provides requirements regarding the offense code field for the additional statute:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeStatuteStatute Provides requirements regarding the free text additional statute field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        CaseChargeStatuteTypeCode Provides requirements regarding the statute type field for a charge:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyCitizenship Provides requirements regarding the citizenship field for a party:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyDateOfBirth Provides requirements regarding the date of birth field for a party:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyEmail Provides requirements regarding the party email field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyEthnicity Provides requirements regarding the ethnicity field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyEyeColor Provides requirements regarding the eye color field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyFBINumber Provides requirements regarding the FBI number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=True, IsRequired=False
        PartyGender Provides requirements regarding the gender field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyHairColor Provides requirements regarding the hair color field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyHeightFeet Provides requirements regarding the height in feet field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyHeightInches Provides requirements regarding the height in inches field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyInterpreter Provides requirements regarding the interpreter field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartyRace Provides requirements regarding the race field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=False, IsRequired=False
        PartySIDNumber Provides requirements regarding the StateID number field:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • Regular Expression, if defined, will constrain the valid values
        • If not defined, defaults to IsVisible=True, IsRequired=False
        PartyWeight Provides requirements regarding the weight field for a party:

        • When IsVisible=True, indicates that the field should be made available to the filer
        • When IsVisible=False, indicates that the field should not be made available to the filer
        • When IsRequired=True, indicates that the field is required
        • When IsRequired=False, indicates that the field is optional
        • If not defined, defaults to IsVisible=False, IsRequired=False



        Court Specific Codes

        Court specific codes define behaviors and field values specific to each court location. Obtain the URL for each code table from the GetPolicy response message.
          All court specific codes include an EFSPCode column. This column provides a value whereby specialized applications can target a specific entry in the code table. This is configured per arrangement with the courts and not applicable to general purpose EFSPs.

          Additional details regarding each court specific code set are provided below.

          Case Category Codes

          This call retrieves a listing of the valid case category codes for a given court location. Case category codes are similar to ECF case types, therefore this code list includes a field for mapping each case category to an ECF case type. EFSPs use this mapping in order to determine the appropriate ECF Case Type schema for a filing.

          Each case category also includes configuration pertaining to the Procedure/Remedy and Damage Amount code fields, where the available values are:

          • Not Available - the field should not be available to the filer
          • Available - the field should be available to the filer
          • Required - the field should be required of the filer
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/casecategory/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Case Category CodesN/ACaseCategoryCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          ecfcasetypeThe corresponding ECF Case Type (AppellateCase, CivilCase, etc.)
          procedureremedyinitialIndicates the behavior of the Procedure/Remedy code field for initial filings (Not Available, Available, Required)
          procedureremedysubsequentIndicates the behavior of the Procedure/Remedy code field for subsequent filings (Not Available, Available, Required)
          damageamountinitialIndicates the behavior of the DamageAmount code field for initial filings (Not Available, Available, Required)
          damageamountsubsequentIndicates the behavior of the DamageAmount code field for subsequent filings (Not Available, Available, Required)



          Case Type Codes

          This call retrieves a listing of the valid case type codes for a given court location. Case type codes are more granular than case category codes. Common examples are Divorce, Contract, and Tax. Each case type belongs to a case category. A case type can be configured as to whether the court accepts new filings of that case type, as well as a case initiation fee amount.
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/casetype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Case Type CodesN/ACaseTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          casecategoryAssociates the code to a particular case category
          initialA boolean that indicates whether the court accepts new cases of this case type
          feeThe court's fee for initiating a case of this case type
          willfileddateIndicates the behavior of the date field for the filing of a will for this case type (Not Available, Available, Required)
          casestreetaddressIndicates the behavior of the address fields for the filing of this case type (Not Available, Available, Required)



          Case Sub Type Codes

          This call retrieves a listing of the valid case sub type codes for a given court location. Case sub type codes are more granular than case type codes. A case sub type is associated to one or more case types. If a case sub type is associated to more than one case type, it will be repeated in this listing.

          The EFSP should use the casetype field to filter down to values for the current filing. If that list is empty, then the case sub type field should not be shown to the filer.

          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/casesubtype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Case Sub Type CodesN/ACaseSubTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          casetypeAssociates the code to a particular case type



          Party Type Codes

          This call retrieves a listing of the valid party type codes for a given court location. Party type codes define the types of parties that can be associated to a case. Party types are defined at the court location but may also be defined for specific case types, and some party types are only allowed once on a given case. Fees may be assessed based upon the existence of/number of parties for a case.

          Each party type code also includes configuration pertaining to fields where the available values represent:

          • Not Available - the field should not be available to the filer
          • Available - the field should be available to the filer
          • Required - the field should be required of the filer
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/partytype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Party Type CodesN/APartyTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          isavailablefornewpartiesIndicates whether a case can have more than one party with this party type
          casetypeid Indicates an association between the party type and a particular case type.
          isrequired Indicates whether the party type is required in order to initiate a case

          NOTE: This field takes precedence over the isavailablefornewparties field. That is, if casetypeid is non-null, such a party must be provided regardless of the value in the isavailablefornewparties field.

          amount Specifies an amount that will be assessed to the filer when adding a party of this type to the case
          numberofpartiestoignore Specifies the number of parties of this type allowed on the case without incurring a fee
          sendforredaction Boolean to indicate whether the EFSP should send such parties' information to the redaction system for redaction. Only applies for filings where redaction is enabled for the court location
          dateofdeath Indicates the behavior of the date of death field for the party (Not Available, Available, Required)
          displayorder Indicates the display order for required parties on configured case types.



          Filing Codes

          This call retrieves a listing of the valid filing codes for a given court location. In order to determine the valid filing codes for a particular case, the EFSP should perform the following steps:

          1. Union the filing codes that are associated to the case category with the filing codes that are associated to the case type. If that list is empty, then use the filing codes that specify neither a case category nor a case type.
          2. Use the iscourtuseonly field to filter out filing codes that are identified as for court use only
          3. Use the filingtype field to filter out filing codes that are not valid for the current filing

          Each filing code also includes configuration pertaining to several fields where the available values represent:

          • Not Available - the field should not be available to the filer
          • Available - the field should be available to the filer
          • Required - the field should be required of the filer
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/filing/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Filing CodesN/AFilingCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          feeThe court's fee for a filing of this type
          casecategoryAssociates the code to a particular case category
          casetypeidAssociates the code to a particular case type
          filingtype Indicates whether this filing code is valid for filing a new case (Initial), a filing on an existing case (Subsequent), or both (Both). Under some circumstances, the filing code is no longer valid for use (None)
          iscourtuseonlyIndicates whether the filing code is reserved for court use only
          civilclaimamountIndicates the behavior of the Civil Claim Amount field for filings (Not Available, Available, Required)
          probateestateamountIndicates the behavior of the ProbateEstateAmount field for filings (Not Available, Available, Required)
          amountincontroversyIndicates the behavior of the Ad Damnum field for filings (Not Available, Required)
          useduedateIndicates whether the filing code allows the use of the due date field
          isproposedorder Indicates whether the filing code is configured for use as a proposed order.
          iswaiverrequest Indicates whether the filing code is configured to request a standing waiver from the court.

          The request is specific to the filer and the case. If a waiver request is granted, it will be for a limited duration. The reviewer will receipt the filing to acknowledge that they have received the waiver request. Thereafter, the court will decide whether to grant or deny the waiver, and if granted, whether in part or in full. If granted, the filer will be able to file into that case and automatically receive the percent waived until the waiver expires. Any non-waived fees must still be collected; therefore, the filer must provide a non-waiver payment account when a partial waiver is in effect. Implications for the use of waivers are provided below:

          1. Per Envelope waivers waive all fees for the envelope, including court fees, Tyler fees, and provider fees.
          2. The system will not allow the filer to use a Per Envelope Waiver if the filer has an active Standing Partial Waiver for the case.
          3. Any payment type will be allowed if there is no active standing waiver .
          4. Partial standing waivers waive court fees at the percentage granted by the court.
          5. Partial standing waivers do not waive Tyler fees.
          6. Partial standing waivers do not waive provider fees.
          7. Full standing waivers waive Tyler fees.
          8. Full standing waivers waive provider fees.
          9. If a waiver request is denied the system does not prevent additional waiver requests.



          Filing Component Codes

          This call retrieves a listing of the valid filing component codes for a given court location. Filing components define the types of business documents allowed for the filing -- for instance, lead documents vs. attachments. Filing component codes are associated to specific filing codes, therefore the EFSP must use the filingcodeid field to filter the list to the entries relevant to a given filing. A filing component may be required for a filing type, and may or may not allow multiple occurrences. If no filing component code is defined for a filing type, no documents are allowed.
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/filingcomponent/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Filing Component CodesN/AFilingComponentCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          filingcodeidAssociates the code to a particular filing code
          requiredIndicates whether or not this filing component is required for the filing
          displayorderAn integer value to represent the order in which to present the filing component. A value will always be present but may be zero, or two rows may have the same value. In either of these cases, the order is irrelevant.
          allowmultipleIndicates whether or not multiple occurrences of this filing component are allowed for the filing
          allowedfiletypesIndicates the types of files that are allowed for this filing component



          Document Type Codes

          This call retrieves a listing of the valid document type codes for a given court location. Document type codes are only applicable if the           DocumentType data field configuration code has IsVisible=true. Document types are associated to specific filing codes and can also be designated for court use only.

          The EFSP should use the filingcodeid field to filter down to values for the current filing. If that list is empty, then use the values where the filingcodeid is empty. Finally, filter out any entries that are marked for court use only.

          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/documenttype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Document Type CodesN/ADocumentTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          filingcodeidAssociates the code to a particular filing code
          iscourtuseonlyIndicates whether the document type code is reserved for court use only
          isdefaultIndicates that this document type code is the default when configured for a filing code



          File Type Codes

          This call retrieves a listing of the valid file type codes for a given court location.
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/filetype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          File Type CodesN/AFileTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          extensionIndicates the valid filename extension for the file type



          Optional Services Codes

          This call retrieves a listing of the valid optional services codes for a given court location. Metadata indicates the filing codes to which each optional service is associated, a fee for the service, and whether an integer multiplier value is required. For instance, certified copies may require the number of copies requested.
          Version3.7
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/optionalservice/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Optional Services CodesN/AOptionalServicesCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          displayorder An integer value to represent the order in which to present the optional services. A value will always be present but may be zero or two rows may have the same value. In either of these cases, the order is irrelevant.
          feeFee associated with this optional service
          filingcodeidFiling code to which the optional service is associated
          multiplierFee multiplier. For instance, a request for 3 certified copies would have a multiplier value of 3
          altfeedescA textual description for a fee that has as calculated value.
          hasfeepromptBoolean to indicate that the filer must provide a fee amount.
          feeprompttextThe text to present to the filer when prompting for the fee amount.
          requiredA boolean to indicate whether the court requires this service.



          Filer Type Codes

          This call retrieves a listing of the valid filer type codes for a given court location. The filer type field is simply metadata about the filer - it has no bearing upon e-filing functionality itself.
          Version3.7
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/filertype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Filer Type CodesN/AFilerTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          defaultIndicates whether this code value is the default filer type



          Procedure/Remedy Codes

          This call retrieves a listing of the valid procedure/remedy codes for a given court location. Procedure/Remedy codes are associated to case category codes. Refer to           Case Category Codes for metadata that pertains to the behavior of this field. The EFSP should use the casecategory field to filter the list down to the codes that are valid for the case relevant to the filing.
          Version3.8
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/procedureremedy/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Procedure/Remedy CodesN/AProcedureRemedyCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          casecategoryAssociates the code to a particular case category



          Damage Amount Codes

          This call retrieves a listing of the valid damage amount codes for a given court location. Damage amount codes are associated to case category codes. Refer to           Case Category Codes for metadata that pertains to the behavior of this field. The EFSP should use the casecategory field to filter the list down to the codes that are valid for the case relevant to the filing.
          Version3.8
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/damageamount/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Damage Amount CodesN/ADamageAmountCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          casecategoryAssociates the code to a particular case category



          Name Suffix Codes

          This call retrieves a listing of the valid name suffix codes for a given court location.
          Version3.10
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/namesuffix/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Name Suffix CodesN/ANameSuffixCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code



          Language Codes

          This call retrieves a listing of language codes This call accepts no input parameters. The actual URL is available through           GetPolicy
          Version3.14
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/language/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Language CodesN/ALanguageCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code



          Cross Reference Codes

          This call retrieves a listing of the valid case number cross reference type codes for a given court location.
          Version3.12
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/crossreference/tyler:dc
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Cross Reference CodesN/ACrossReferenceCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          casetypeidIndicates that this cross reference type code is available for the specified case type
          isdefaultIndicates that this cross reference type code is the default for the case type
          isrequiredIndicates that this cross reference type code is required for the case type
          validationregexIndicates the regular expression used to validate the cross reference number
          customvalidationfailuremessageA text string that contains a message to address a failure of the validation regex



          Disclaimer Requirement Codes

          A court may require that filers agree to a set of disclaimers before submitting each filing. This call retrieves a listing of such requirements. If such requirements exist, the EFSP must display these disclaimers and require the user to acknowledge each one before allowing the filer to submit.

          NOTE: These disclaimers can include HTML markup. The EFM takes measures to sanitize the content for security purposes but the EFSP should take similar measures as part of a "defense in depth" best practice.

          Version2018.0
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/disclaimerrequirement/tyler:dc
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Disclaimer Requirement CodesN/ADisclaimerRequirementCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          listorder An integer value to indicate the order of the disclaimer if there are more than one disclaimer for the court
          requirementtextThe text of the disclaimer to which the filer is agreeing



          Motion Type Codes

          This call retrieves a listing of the valid motion type codes for a given court location. Filing component codes are associated to specific filing codes, therefore the EFSP must use the filingcodeid field to filter the list to the entries relevant to a given filing. A motion type may be required for a filing type, and may or may not allow multiple occurrences.
          Version2019.0
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/motiontype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Motion Type CodesN/AMotionTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          filingcodeidAssociates the code to a particular filing code
          hearinglocationvisibleIndicates if Hearing Location is a visible option for filers to use when scheduling Ad Hoc Hearings
          hearinglocationrequiredIndicates if Hearing Location is a required option for filers to use when scheduling Ad Hoc Hearings. Always false when visible is false.
          hearingjudgevisibleIndicates if Hearing Judge is a visible option for filers to use when scheduling Ad Hoc Hearings
          hearingjudgerequiredIndicates if Hearing Judge is a required option for filers to use when scheduling Ad Hoc Hearings. Always false when visible is false.
          hearingdatevisibleIndicates if Hearing Date is a visible option for filers to use when scheduling Ad Hoc Hearings
          hearingdaterequiredIndicates if Hearing Date is a required option for filers to use when scheduling Ad Hoc Hearings. Always false when visible is false.
          hearingtimevisibleIndicates if Hearing Time is a visible option for filers to use when scheduling Ad Hoc Hearings
          hearingtimerequiredIndicates if Hearing Time is a required option for filers to use when scheduling Ad Hoc Hearings. Always false when visible is false.



          Service Type Codes

          This call retrieves a listing of service type codes. This call accepts no input parameters. The actual URL is available through           GetPolicy
          Version3.14
          RequiredCore functionality
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/servicetype/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Service Type CodesN/AServiceTypeCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          servicemethod A system level value that the EFM uses to determine the type of service to perform
          fee The amount of the service fee for the service type. A NULL value indicates that no fee applies
          disclaimertext Additional text information regarding the service type



          Question Codes

          This call retrieves a listing of the valid question codes for a given court location. Question codes are associated to answer codes, therefore the EFSP must use the questionid field to filter the answer list to the entries relevant to a given question.
          Version2019.1
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/question/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Question CodesN/AQuestionCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          questiontextThe text of the question being asked.
          helptextThe help text to display for the question field.
          isrequiredA boolean that indicates whether the answer to the question must be selected.



          Answer Codes

          This call retrieves a listing of the valid answer codes for a given court location. Answer codes are associated to specific question codes, therefore the EFSP must use the questionid field to filter the list to the entries relevant to a given question.
          Version2019.1
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/answer/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Answer CodesN/AAnswerCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          answertextThe text of the answer.
          questionidThe code of the question to which the answer is relevant.



          Refund Reason Codes

          This call retrieves a listing of the refund reason codes for a given court location. Refund reason codes indicate why the reviewer performed a refund.
          Version2022.1
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/refundreason/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Refund Reason CodesN/Arefundreasoncodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code



          Service Provider Codes

          This call retrieves a listing of valid Service Providers codes for a given court location. These codes include standard data along with the type of service each Service Provider supports and the Fee that they charge.
          Version2025.2
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/serviceprovider/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Service Provider CodesN/AServiceProviderCodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          efspcodeThe EFSP identifier for the code
          servicetypecodeidThe type of service this Service Provider uses
          feeThe Fee amount that this Service Provider charges



          Notification Agency Codes

          This call retrieves a listing of valid Notification Agency Codes for a given court location. These codes include standard data along with the type of service each Service Provider supports and the Fee that they charge.
          Version2025.3
          RequiredConditional functionality, subject to business requirements
          Sample URLhttps://court.tylertech.cloud/CodeService/codes/notificationagency/tyler:dc/
          Request Message DefinitionN/A
          Response Message Definitiongenericode
          XML Samples
          DescriptionRequestResponse
          Notification Agency CodesN/Anotificationagencycodes
          Inputs
          FieldDescription
          No Inputs
          Outputs
          FieldDescription
          codeUnique EFM identifier for the code
          nameTextual description of the code
          efspcodeThe EFSP identifier for the code
          casetypecodeidThe EFM identifier of the case type this Agency is configured for
          firmnameThe name of the firm associated with this Agency
          firmidThe EFM identifier of the firm associated with this Agency



          Criminal Initiation Specific Codes

          Criminal initiation specific codes define behaviors and field values specific to each court location. Obtain the URL for each code table from the GetPolicy response message.
            All criminal initiation specific codes include an EFSPCode column. This column provides a value whereby specialized applications can target a specific entry in the code table. This is configured per arrangement with the courts and not applicable to general purpose EFSPs.

            Additional details regarding each criminal initiation specific code set are provided below.

            Arrest Location Codes

            This call retrieves a listing of the valid arrest location codes for a given court location.
            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/arrestlocation/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Arrest Location CodesN/AArrestLocationCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Bond Codes

            This call retrieves a listing of the valid bond codes for a given court location.
            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/bond/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Bond CodesN/ABondCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Charge Phase Codes

            This call retrieves a listing of the valid charge phase codes for a given court location.
            Version2017.2
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/chargephase/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Charge Phase CodesN/AChargePhaseCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Degree Codes

            This call retrieves a listing of the valid degree codes for a given court location.

            The EFSP should use the statute code id field to filter down to values for the offense. If that list is empty, then use the values where the statute code id is empty.

            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/degree/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Degree CodesN/ADegreeCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code
            statutecodeidA statute code



            Driver License Type Codes

            This call retrieves a listing of the valid driver license type codes for a given court location.
            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/driverlicensetype/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Driver License Type CodesN/ADriverLicenseTypeCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Ethnicity Codes

            This call retrieves a listing of the valid ethnicity codes for a given court location.
            Version2017.2
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/ethnicity/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Ethnicity CodesN/AEthnicityCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Eye Color Codes

            This call retrieves a listing of the valid eye color codes for a given court location.
            Version2017.2
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/eyecolor/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Eye Color CodesN/AEyeColorCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            General Offense Codes

            This call retrieves a listing of the valid general offense codes for a given court location.

            The EFSP should use the statute code id field to filter down to values for the offense. If that list is empty, then use the values where the statute code id is empty.

            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/generaloffense/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            General Offense CodesN/AGeneralOffenseCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code
            statutecodeidA statute code



            Hair Color Codes

            This call retrieves a listing of the valid hair color codes for a given court location.
            Version2017.2
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/haircolor/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Hair Color CodesN/AHairColorCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Law Enforcement Unit Codes

            This call retrieves a listing of the valid law enforcement unit codes for a given court location.
            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/lawenforcementunit/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Law Enforcement Unit CodesN/ALawEnforcementUnitCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Physical Feature Codes

            This call retrieves a listing of the valid physical feature codes for a given court location.
            Version2017.2
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/physicalfeature/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Physical Feature CodesN/APhysicalFeatureCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Race Codes

            This call retrieves a listing of the valid race codes for a given court location.
            Version2017.2
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/race/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Race CodesN/ARaceCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Statute Codes

            This call retrieves a listing of the valid statute codes for a given court location.
            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/statute/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Statute CodesN/AStatuteCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code
            wordA statute code that is meaningful outside the e-filing system, typically defined by the statute from which the offense originates
            referenceidA statute code such as a legacy code that can be used as another method to find the appropriate code
            efspcodeA statute code that is meaningful to the EFSP



            Statute Type Codes

            This call retrieves a listing of the valid statute type codes for a given court location.
            Version3.12
            RequiredCore functionality
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/statutetype/tyler:dc
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Bond CodesN/AStatuteTypeCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Citation Jurisdiction Codes

            This call retrieves a listing of the valid citation jurisdiction codes for a given court location.
            Version2019.0
            RequiredConditional functionality, subject to business requirements
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/citationjurisdiction/tyler:dc/
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Citation Jurisdiction CodesN/ACitationJurisdictionCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Vehicle Color Codes

            This call retrieves a listing of the valid vehicle color codes for a given court location.
            Version2019.0
            RequiredConditional functionality, subject to business requirements
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/vehiclecolor/tyler:dc/
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Vehicle Color CodesN/AVehicleColorCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Vehicle Make Codes

            This call retrieves a listing of the valid vehicle make codes for a given court location.
            Version2019.0
            RequiredConditional functionality, subject to business requirements
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/vehiclemake/tyler:dc/
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Vehicle Make CodesN/AVehicleMakeCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Vehicle Type Codes

            This call retrieves a listing of the valid vehicle type codes for a given court location.
            Version2019.0
            RequiredConditional functionality, subject to business requirements
            Sample URLhttps://court.tylertech.cloud/CodeService/codes/vehicletype/tyler:dc/
            Request Message DefinitionN/A
            Response Message Definitiongenericode
            XML Samples
            DescriptionRequestResponse
            Vehicle Type CodesN/AVehicleTypeCodes
            Inputs
            FieldDescription
            No Inputs
            Outputs
            FieldDescription
            codeUnique EFM identifier for the code
            nameTextual description of the code



            Administrative APIs

            The administrative APIs provide for functionality on behalf of firms and users.
              Access Control
              These APIs require signed SOAP headers to provide system to system authentication. Sample .NET/WCF code is available here.

              The administrative APIs are modeled after ECF, which includes an ErrorCodeText element for returning errors in response to a request. Successful queries return an ErrorCodeText of 0. Failed queries return an appropriate ErrorCodeText value as defined in the court policy.

              Additional details regarding both sets of administrative APIs are provided below.

              Firm Administration APIs

              The EFM Firm Service APIs provide the ability to register and manage users and firms, attorneys, service contacts, and payment accounts.
                Details regarding each of the firm administration APIs are provided below.

                Managing the Firm's Users

                The following APIs provide the ability to register a new firm and to register and manage additional users.
                  Details regarding each of the firm user management APIs are provided below.

                  RegisterUser

                  RegisterUser registers a new user within the EFM. The new user may belong to an existing firm, a new firm to be created, or an individual user who is not associated to a firm. All user registrations are subject to an account activation process whereby the EFM sends an activation link to the email address being registered. The associated File & Serve account is not valid for use until the user clicks the verification link.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToIf registration type is FirmAdminNewMember then only firm administrator, otherwise any user. If CSM is enabled, requires the AddNewUsers resource to add users to an existing firm.
                  User CredentialsConditional - If registration type is FirmAdminNewMember then User/PasswordHash required, otherwise an unauthenticated call with no credentials necessary
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionRegistrationRequest
                  Response Message DefinitionRegistrationResponse
                  XML Samples
                  DescriptionRequestResponse
                  New FirmNewFirmRegistrationMessageRegistrationResponseMessage
                  New Firm UserNewFirmUserRegistrationMessageRegistrationResponseMessage
                  New Individual UserNewIndividualUserRegistrationMessageRegistrationResponseMessage
                  Inputs
                  FieldDescription
                  RegistrationTypeThis is the type of user to register. Valid types are:
                  • FirmAdministrator - registers a new firm and its administrator. This value is only valid when creating the firm.
                  • FirmAdminNewMember - registers a new user within an existing firm. This user will be a filer, but a Firm Administrator can promote this user to be a firm administrator via the AddUserRole API.
                  • Individual - registers a new individual user within the system, not associated with a law firm.
                  Refer to CSM when enabled.
                  EmailEmail address for the user to register. The user will use this email address to sign on to the system.
                  FirstNameFirst name of the user to register
                  MiddleNameMiddle name of the user to register.
                  LastNameLast name of the user to register.
                  Password Clear-text password for the user to register. Not required/used for RegistrationType of FirmAdminNewMember. The EFM auto-generates the password and sends it to the user's email address as part of the account activation process. Users should then set their desired password. Password complexity requirements are configured within the EFM. Refer to the GlobalPassword data field configuration code for more information. NOTE: The password field is moot when Okta is enabled. Refer to the Authentication specification for more details.
                  PasswordQuestion NOTE: The password reset question/answer is deprecated in version 3.14; however, this API will continue to accept the fields in order to preserve backward compatibility.

                  Question to use as a password reminder for the registering user. Not required/used for RegistrationType of FirmAdminNewMember

                  PasswordAnswer NOTE: The password reset question/answer is deprecated in version 3.14; however, this API will continue to accept the fields in order to preserve backward compatibility.

                  Answer for the password reminder question. Not required/used for RegistrationType of FirmAdminNewMember

                  StreetAddressLine1Street address of the new firm's address. Required when registering a new firm or individual user account
                  StreetAddressLine2Secondary address apt, unit, etc. of the new firm's address
                  CityCity portion of the new firm's address. Required when registering a new firm or individual user account
                  StateCodeState code of the new firm's address. Required when registering a new firm or individual user account
                  ZipCode Zip code of the new firm's address. US addresses must be of the standard 5 digit or 5-4 digit form. Required when registering a new firm or individual user account
                  CountryCodeCountry code of the new firm's address. Required when registering a new firm or individual user account
                  FirmIDUnique EFM identifier for the firm. Required to register a FirmAdminNewMember
                  FirmNameName of the firm to register. Required to register a FirmAdministrator as it creates a new firm record
                  PhoneNumberPhone number for the new firm. Required when registering a new firm or individual user account
                  FirmIDA new element that distinguishes between a user registering from a firm invitation and a user registering as a new firm.
                  Outputs
                  FieldDescription
                  Error If the EFM is configured to use Okta for authentication and the user already has an active account within Okta, the EFM will return error 960. Please refer to the User Authentication Specification for additional details.
                  UserIDUnique EFM identifier for the new user account
                  PasswordHashResult of the hash function applied to the password
                  ActivationRequiredIndicator as to whether the account has been activated
                  ExpirationDateTimeUTC date/time when the PasswordHash will expire



                  AddUserRole

                  NOTE: This API will return error 1801 when the Composable Security Model is enabled on the site. The GetPolicy API indicates whether CSM is enabled.


                  AddUserRole enables the firm administrator to grant a role to a firm user, where the possible values are Filer and FirmAdmin. The capabilities of each are outlined below.

                  FunctionFilerFirm Admin
                  Search for casesYesYes
                  Submit filingsYesYes
                  Use firm's service contactsYesYes
                  Use firm's payment accountsYesYes
                  Manage his/her account profileYesYes
                  Register new usersNoYes
                  Reset other users' passwordsNoYes
                  Unlock user accounts for firm users locked outNoYes
                  Remove user accounts for firm usersNoYes
                  Designate additional firm administratorsNoYes
                  Create/manage payment accountsNoYes
                  Create/manage attorneysNoYes
                  Create/manage service contactsNoYes
                  View all filings for the firmNoYes

                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, this API is deprecated.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionAddUserRoleRequest
                  Response Message DefinitionBaseResponse
                  XML Samples
                  DescriptionRequestResponse
                  AddUserRoleAddUserRoleMessageBaseResponseMessage
                  AddUserRole - Criminal Filing Filer RoleAddUserRoleMessage-CriminalBaseResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the firm user
                  Role Role to assign to the user. There are four possible roles: A user must have the CriminalFilingFirmAdmin role in order to assign the CriminalFilingFirmAdmin and CriminalFilingFiler roles. Tyler must assign the CriminalFilingFirmAdmin role to the first person in the firm
                  LocationLocation element is only applicable (and required) when assigning the CriminalFilingFiler role
                  Outputs
                  FieldDescription
                  No Outputs



                  GetUser (Firm Service)

                  GetUser enables a firm administrator to retrieve the information for a firm user account.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, any authenticated user.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionGetUserRequest
                  Response Message DefinitionGetUserResponse
                  XML Samples
                  DescriptionRequestResponse
                  GetUserGetUserMessageGetUserResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user account
                  Outputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user account
                  EmailEmail address for the user
                  FirstNameFirst name of the user
                  MiddleNameMiddle name of the user
                  LastNameLast name of the user
                  LastLoginDateDate and timestamp when the user last logged into the system via the AuthenticateUser API
                  Role NOTE: This element will not be emitted when the Composable Security Model is enabled on the site. The GetPolicy API indicates whether this is enabled.

                  This element repeats as needed to indicate the roles granted to this user. There are two child elements: the role name and the court location for which the user has been granted the role. Valid roles are Filer, FirmAdmin, CriminalFilingFiler, and CriminalFilingFirmAdmin. The location only applies to the CriminalFilingFiler and CriminalFilingFirmAdmin roles. The location element will be empty for all other roles

                  RestrictFilingA read-only boolean indicating whether the user's ability to submit filings has been administratively restricted by Tyler
                  RestrictFilingCommentA read-only description of why the user's ability to submit filing has been restricted
                  IsUndeliverableA read-only boolean indicating whether or not the user's email is deliverable
                  StatusThis element indicates whether a user is Active, Inactive, Deactivated or Suspended.



                  GetUserList

                  GetUserList retrieves a list of the users in the user's firm. If the authenticated user does not have firm administrator privileges, then the returned information is for the current user.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToAny registered user. No different when CSM is enabled.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionGetUserListRequest
                  Response Message DefinitionUserListResponse
                  XML Samples
                  DescriptionRequestResponse
                  GetUserListGetUserListUserListResponseMessage
                  Inputs
                  FieldDescription
                  PageIndexThe page of users being queried
                  PageSizeThe number of users per page being queried
                  Outputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user
                  EmailEmail address for the user
                  FirstNameFirst name of the user
                  MiddleNameMiddle name of the user
                  LastNameLast name of the user
                  LastLoginDateDate and timestamp when the user last logged into the system via the AuthenticateUser API
                  Role This element repeats as needed to indicate the role names granted to this user and for which court locations
                  RestrictFilingA read-only boolean indicating whether the user's ability to submit filings has been administratively restricted by Tyler
                  RestrictFilingCommentA read-only description of why the user's ability to submit filing has been restricted
                  IsUndeliverableA read-only boolean indicating whether or not the user's email is deliverable
                  StatusIndicates a user's Status, which can be Active or Suspended.
                  PageIndexThe page of users being queried
                  PageSizeThe number of users per page being queried
                  TotalSizeThe total number of users that can be returned. Does not change with page index or size.



                  RemoveUser

                  RemoveUser enables a firm administrator to remove a user from the firm.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, requires the DeleteUsers resource.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionRemoveUserRequest
                  Response Message DefinitionBaseResponse
                  XML Samples
                  DescriptionRequestResponse
                  RemoveUserRemoveUserMessageBaseResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user
                  Outputs
                  FieldDescription
                  No Outputs



                  RemoveUserRole

                  NOTE: This API will return error 1801 when the Composable Security Model is enabled on the site. The GetPolicy API indicates whether this is enabled.

                  RemoveUserRole enables a firm administrator to remove a role from a firm user.

                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, this API is deprecated.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionRemoveUserRoleRequest
                  Response Message DefinitionBaseResponse
                  XML Samples
                  DescriptionRequestResponse
                  RemoveUserRoleRemoveUserRoleMessageBaseResponseMessage
                  RemoveUserRoleRemoveUserRoleMessage-CriminalBaseResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the firm user
                  Role Role to remove from the user. There are four possible roles:
                  • Filer
                  • FirmAdmin
                  • CriminalFilingFiler
                  • CriminalFilingFirmAdmin
                  A user must have the CriminalFilingFirmAdmin role in order to remove the CriminalFilingFirmAdmin or CriminalFilingFiler roles
                  LocationLocation element is only applicable (and required) when assigning the CriminalFilingFiler role
                  Outputs
                  FieldDescription
                  No Outputs



                  ResendActivationEmail

                  ResendActivationEmail allows a firm administrator to re-send the account activation email for a new user.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, requires the ResetUserPasswords resource.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionResendActivationEmailRequest
                  Response Message DefinitionBaseResponse
                  XML Samples
                  DescriptionRequestResponse
                  ResendActivationEmailResendActivationEmailMessageBaseResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user
                  Outputs
                  FieldDescription
                  No Outputs



                  ResetUserPassword

                  ResetUserPassword enables a firm administrator to change a firm user's password.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, requires the ResetUserPassword resource.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionResetUserPasswordRequest
                  Response Message DefinitionResetPasswordResponse
                  XML Samples
                  DescriptionRequestResponse
                  ResetUserPasswordResetUserPasswordMessageResetPasswordResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user
                  EmailEmail address of the user
                  Password New password for the user Password complexity requirements are configured within the EFM. Refer to the GlobalPassword data field configuration code for more information.
                  Outputs
                  FieldDescription
                  PasswordHash Unique value assigned to the user by the EFM for subsequent interactions with the EFM. While the value is actually a GUID, the concept is similar to a password hash for the user



                  UpdateUser (Firm Service)

                  UpdateUser enables the firm administrator to update account details for a firm user.
                  Version3.7
                  RequiredCore functionality
                  Accessible ToFirm Administrators Only. If CSM is enabled, requires the EditUsers resource.
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionUpdateUserRequest
                  Response Message DefinitionUpdateUserResponse
                  XML Samples
                  DescriptionRequestResponse
                  UpdateUserUpdateUserMessageUpdateUserResponseMessage
                  Inputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user
                  EmailEmail address of the user
                  FirstNameFirst name of the user
                  MiddleNameMiddle name of the user
                  LastNameLast name of the user
                  Outputs
                  FieldDescription
                  UserIDUnique EFM identifier for the user



                  GetNotificationPreferencesList

                  GetNotificationPreferencesList obtains a list of notification emails to which the user may choose to subscribe.
                  Version3.9
                  RequiredConditional functionality, subject to business requirements
                  Accessible ToAny registered user
                  User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                  ServiceEFMFirmService
                  Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                  Request Message DefinitionBaseRequest
                  Response Message DefinitionNotificationPreferencesListResponse
                  XML Samples
                  DescriptionRequestResponse
                  GetNotificationPreferencesN/AGetNotificationPreferencesListResponse
                  Inputs
                  FieldDescription
                  No Inputs
                  Outputs
                  FieldDescription
                  ACCEPTEDIndicates whether the EFM will notify when a filing is accepted by the court
                  ACCOUNTLOCKEDIndicates whether the EFM will notify when the user's account has been locked
                  RECEIPTEDIndicates whether the EFM will notify when a filing is receipted by the court. This is not a monetary receipt, but rather, a special purpose form of acceptance of a filing that a jurisdiction may elect to employ
                  REJECTEDIndicates whether the EFM will notify when a filing is rejected, either by the EFM or the court
                  RETURNFORCORRECTIONIndicates whether the EFM will notify when a filing has been returned for correction by the court
                  SERVICEUNDELIVERABLEIndicates whether the EFM will notify when an attempted service cannot be delivered
                  SUBMISSIONFAILEDIndicates whether the EFM will notify when a filing is fails in submission to the EFM
                  SUBMITTEDIndicates whether the EFM will notify when a filing is successfully submitted to the EFM



                  Managing a Firm

                  The following APIs provide the firm administrator the ability to manage information about the firm.
                    Details regarding the firm management APIs are provided below.

                    GetFirm

                    GetFirm retrieves information about the authenticated user's firm.
                    Version3.7
                    RequiredCore functionality
                    Accessible ToAny registered user. No different when CSM is enabled.
                    User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                    ServiceEFMFirmService
                    Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                    Request Message DefinitionBaseRequest
                    Response Message DefinitionGetFirmResponse
                    XML Samples
                    DescriptionRequestResponse
                    GetFirmN/AGetFirmResponseMessage
                    Inputs
                    FieldDescription
                    No Inputs
                    Outputs
                    FieldDescription
                    FirmIDUnique EFM identifier for the firm
                    IsIndividual Indicates whether this is a true firm or a psuedy-firm of an individual filer
                    IsAgency Indicates whether this firm is a governmental agency. This flag is set by Tyler support.
                    FirmNameName of the firm
                    AddressLine1Street address
                    AddressLine2Additional address information
                    CityCity portion of the address
                    StateState code of the address
                    ZipCodeZip code of the address
                    CountryCountry code of the address
                    PhoneNumberPhone number for the firm contact



                    UpdateFirm

                    UpdateFirm provides the ability to update firm information.

                    NOTE: Individual user accounts have an underlying firm record, even though they are unable to perform other firm management APIs.

                    Version3.7
                    RequiredCore functionality
                    Accessible ToFirm Administrators Only. If CSM is enabled, requires the EditFirmInformation resource.
                    User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                    ServiceEFMFirmService
                    Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                    Request Message DefinitionUpdateFirmRequest
                    Response Message DefinitionBaseResponse
                    XML Samples
                    DescriptionRequestResponse
                    UpdateFirmUpdateFirmMessageBaseResponseMessage
                    Inputs
                    FieldDescription
                    FirmNameName of the firm
                    AddressLine1Street address
                    AddressLine2Additional address information
                    CityCity portion of the address
                    StateState code of the address
                    ZipCode Zip code of the address. US addresses must be of the standard 5 digit or 5-4 digit form
                    CountryCountry code of the address
                    PhoneNumberPhone number for the firm contact
                    Outputs
                    FieldDescription
                    No Outputs



                    Managing Attorneys

                    The following APIs provide the ability to add, update, and remove attorneys for the firm.
                      NOTE: For markets with a feed from the state bar, attorneys no longer in good standing will be deactivated automatically.

                      Details regarding the attorney management APIs are provided below.

                      CreateAttorney

                      This function enables a firm administrator to create an attorney for the firm.
                      Version3.7
                      RequiredCore functionality
                      Accessible ToFirm Administrators Only. If CSM is enabled, requires the AddAttorneys resource.
                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                      ServiceEFMFirmService
                      Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                      Request Message DefinitionCreateAttorneyRequest
                      Response Message DefinitionCreateAttorneyResponse
                      XML Samples
                      DescriptionRequestResponse
                      Create AttorneyCreateAttorneyMessageCreateAttorneyResponseMessage
                      Inputs
                      FieldDescription
                      BarNumber State bar number assigned to the attorney. The value provided may be subject to validation. Refer to the GlobalAttorneyNumberVerifyButton data field configuration code for more information
                      FirstNameFirst name of the attorney
                      MiddleNameMiddle name of the attorney
                      LastNameLast name of the attorney
                      Outputs
                      FieldDescription
                      AttorneyIDUnique EFM identifier for the attorney



                      GetAttorneyList

                      GetAttorneyList retrieves a list of the attorneys in the authenticated user's firm.
                      Version3.7
                      RequiredCore functionality
                      Accessible ToAny registered user who belongs to a firm. If CSM is enabled, requires the ViewAttorneys resource.
                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                      ServiceEFMFirmService
                      Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                      Request Message DefinitionBaseRequest
                      Response Message DefinitionAttorneyListResponse
                      XML Samples
                      DescriptionRequestResponse
                      GetAttorneyListN/AAttorneyListResponseMessage
                      Inputs
                      FieldDescription
                      No Inputs
                      Outputs
                      FieldDescription
                      AttorneyIDUnique EFM identifier for the attorney
                      BarNumberState bar number assigned to the attorney
                      FirstNameFirst name of the attorney
                      MiddleNameMiddle name of the attorney
                      LastNameLast name of the attorney
                      Email Email address of the attorney. Populated from the State Bar feed, if applicable



                      GetAttorney

                      GetAttorney retrieves the information for a firm's attorney.
                      Version3.7
                      RequiredCore functionality
                      Accessible ToAny registered user who belongs to a firm. If CSM is enabled, requires the ViewAttorneys resource.
                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                      ServiceEFMFirmService
                      Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                      Request Message DefinitionGetAttorneyRequest
                      Response Message DefinitionGetAttorneyResponse
                      XML Samples
                      DescriptionRequestResponse
                      GetAttorneyGetAttorneyMessageGetAttorneyResponseMessage
                      Inputs
                      FieldDescription
                      AttorneyIDUnique EFM identifier for the attorney
                      Outputs
                      FieldDescription
                      BarNumberState bar number assigned to the attorney
                      FirstNameFirst name of the attorney
                      MiddleNameMiddle name of the attorney
                      LastNameLast name of the attorney
                      Email Email address of the attorney. Populated from the State Bar feed, if applicable



                      RemoveAttorney

                      This function enables a firm administrator to remove an attorney from the firm.
                      Version3.7
                      RequiredCore functionality
                      Accessible ToFirm Administrators Only. If CSM is enabled, requires the DeleteAttorneys resource.
                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                      ServiceEFMFirmService
                      Sample URL https://court.tylertech.cloud/efm/EFMFirmService.svc
                      Request Message DefinitionRemoveAttorneyRequest
                      Response Message DefinitionBaseResponse
                      XML Samples
                      DescriptionRequestResponse
                      Remove AttorneyRemoveAttorneyMessageBaseResponseMessage
                      Inputs
                      FieldDescription
                      AttorneyIDUnique EFM identifier for the attorney
                      Outputs
                      FieldDescription
                      No Outputs



                      UpdateAttorney

                      This function enables a firm administrator to update an attorney for the firm.
                      Version3.7
                      RequiredCore functionality
                      Accessible ToFirm Administrators Only. If CSM is enabled, requires the EditAttorneys resource.
                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                      ServiceEFMFirmService
                      Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                      Request Message DefinitionUpdateAttorneyRequest
                      Response Message DefinitionUpdateAttorneyResponse
                      XML Samples
                      DescriptionRequestResponse
                      Update AttorneyUpdateAttorneyMessageUpdateAttorneyResponseMessage
                      Inputs
                      FieldDescription
                      AttorneyIDUnique EFM identifier for the attorney
                      BarNumber State bar number assigned to the attorney. The value provided may be subject to validation. Refer to the GlobalAttorneyNumberVerifyButton data field configuration code for more information
                      FirstNameFirst name of the attorney
                      MiddleNameMiddle name of the attorney
                      LastNameLast name of the attorney
                      Outputs
                      FieldDescription
                      AttorneyIDUnique EFM identifier for the attorney



                      Managing Service Contacts

                      The following APIs allow the firm administrator to manage service contacts for the firm.
                        Details regarding the service contact management APIs are provided below.

                        CreateServiceContact

                        CreateServiceContact creates a new service contact for the firm. Thereafter, the service contact record can be attached to cases in order to receive service. Email address and/or a postal address may be required. Refer to ServiceContactEmailAddress and ServiceContactStreetAddress data field configuration codes for more information.
                        Version3.7
                        RequiredCore functionality
                        Accessible ToAny registered user. If CSM is enabled, requires the ManageFirmServiceContacts resource.
                        User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                        ServiceEFMFirmService
                        Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                        Request Message DefinitionCreateServiceContactRequest
                        Response Message DefinitionCreateServiceContactResponse
                        XML Samples
                        DescriptionRequestResponse
                        CreateServiceContactCreateServiceContactMessageCreateServiceContactResponseMessage
                        Inputs
                        FieldDescription
                        FirstNameFirst name of the service contact
                        MiddleNameMiddle name of the service contact
                        LastNameLast name of the service contact
                        EmailEmail address of the service contact. This address is used for official e-service notification. SMTP logs are stored for e-service to this address
                        AdministrativeCopy Comma separated list of email addresses to receive an email when this service contact receives electronic service Administrative copies are not sent when service is performed via US Postal Service. Unlike the primary email, SMTP logs are not stored for administrative copies
                        AddressLine1Street address
                        AddressLine2Additional address information
                        CityCity portion of the address
                        StateState code of the address
                        ZipCode Zip code portion of the address. US addresses must be of the standard 5 digit or 5-4 digit form
                        CountryCountry code of the address
                        PhoneNumberPhone number for the service contact
                        IsPublicBoolean value to indicate whether this service contact is to be included in the public list
                        IsInFirmMasterList Boolean value to indicate whether this service contact is to be included in the firm's master list.

                        NOTE: Once a service contact is added to the firm master list it cannot be removed from the master list; however, it can be removed from the firm via the RemoveServiceContact API

                        IsMailServiceContactBoolean value to indicate whether this service contact is a mail service contact, and should not receive eService.
                        Outputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact



                        GetServiceContactList

                        GetServiceContactList retrieves the firm's list of service contacts.
                        Version3.7
                        RequiredCore functionality
                        Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                        User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                        ServiceEFMFirmService
                        Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                        Request Message DefinitionBaseRequest
                        Response Message DefinitionServiceContactListResponse
                        XML Samples
                        DescriptionRequestResponse
                        GetServiceContactListN/AServiceContactListResponseMessage
                        Inputs
                        FieldDescription
                        No Inputs
                        Outputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact
                        FirmIDUnique EFM identifier for the firm to which the service contact belongs. For GetServiceContactList this will be the ID of the current user's firm. This same schema construct of ServiceContact is also used by the GetPublicList API, where this field is more relevant.
                        AddByFirmNameName of the firm who added this service contact at the time the service contact was added to the firm. For GetServiceContactList this will be the ID of the current user's firm name. This same schema construct of ServiceContact is also used by the GetPublicList API, where this field is more relevant.
                        FirstNameFirst name of the service contact
                        MiddleNameMiddle name of the service contact
                        LastNameLast name of the service contact
                        EmailEmail address of the service contact. This address is used for official e-service notification. SMTP logs are stored for e-service to this address
                        AdministrativeCopy Comma separated list of email addresses to receive a copy of e-service
                        Address Physical mailing address for the service contact
                        IsPublicBoolean value to indicate whether the service contact is included in the public list
                        IsInFirmMasterList Boolean to indicate whether the service contact is included in the firm master list
                        IsMailServiceContactBoolean value to indicate whether this service contact is a mail service contact, and should not receive eService.
                        IsUndeliverableA read-only boolean indicating whether or not the service contact's email is deliverable



                        GetServiceContact

                        GetServiceContact retrieves a service contact record for one of the firm's existing service contacts.
                        Version3.7
                        RequiredCore functionality
                        Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                        User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                        ServiceEFMFirmService
                        Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                        Request Message DefinitionGetServiceContactRequest
                        Response Message DefinitionGetServiceContactResponse
                        XML Samples
                        DescriptionRequestResponse
                        GetServiceContactGetServiceContactMessageGetServiceContactResponseMessage
                        Inputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact
                        Outputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact
                        FirmIDUnique EFM identifier for the firm to which the service contact belongs. For GetServiceContactList this will be the ID of the current user's firm. This same schema construct of ServiceContact is also used by the GetPublicList API, where this field is more relevant.
                        FirstNameFirst name of the service contact
                        MiddleNameMiddle name of the service contact
                        LastNameLast name of the service contact
                        EmailEmail address of the service contact. This address is used for official e-service notification. SMTP logs are stored for e-service to this address
                        AdministrativeCopyComma separated list of email addresses to receive an email when this service contact receives e-service. Unlike the primary email, SMTP logs are not stored for administrative copies
                        AddressLine1Street address
                        AddressLine2Additional address information
                        CityCity portion of the address
                        StateState code of the address
                        ZipCodeZip code portion of the address
                        CountryCountry code of the address
                        PhoneNumberPhone number for the service contact
                        IsPublicBoolean value to indicate whether this service contact is to be included in the public list
                        IsInFirmMasterListBoolean to indicate whether the service contact is included in the firm master list
                        IsMailServiceContactBoolean value to indicate whether this service contact is a mail service contact, and should not receive eService.
                        IsUndeliverableA read-only boolean indicating whether or not the service contact's email is deliverable



                        RemoveServiceContact

                        RemoveServiceContact removes an existing service contact record from the firm's list of service contacts.
                        Version3.7
                        RequiredCore functionality
                        Accessible ToFirm Administrators Only. If CSM is enabled, requires the ManageFirmServiceContacts resource.
                        User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                        ServiceEFMFirmService
                        Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                        Request Message DefinitionRemoveServiceContactRequest
                        Response Message DefinitionBaseResponse
                        XML Samples
                        DescriptionRequestResponse
                        RemoveServiceContactRemoveServiceContactMessageBaseResponseMessage
                        Inputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact
                        Outputs
                        FieldDescription
                        No Outputs



                        UpdateServiceContact

                        UpdateServiceContact updates the details of an existing service contact record. Email address and/or a postal address may be required. Refer to                         Data Field Configuration Codes for more information
                        Version3.7
                        RequiredCore functionality
                        Accessible ToFirm Administrators Only. If CSM is enabled, requires the ManageFirmServiceContacts resource.
                        User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                        ServiceEFMFirmService
                        Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                        Request Message DefinitionUpdateServiceContactRequest
                        Response Message DefinitionUpdateServiceContactResponse
                        XML Samples
                        DescriptionRequestResponse
                        UpdateServiceContactUpdateServiceContactMessageUpdateServiceContactResponseMessage
                        Inputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact
                        FirstNameFirst name of the service contact
                        MiddleNameMiddle name of the service contact
                        LastNameLast name of the service contact
                        EmailEmail address of the service contact. This address is used for official e-service notification. SMTP logs are stored for e-service to this address
                        AdministrativeCopyComma separated list of email addresses to receive an email when this service contact receives e-service. Unlike the primary email, SMTP logs are not stored for administrative copies
                        AddressLine1Street address
                        AddressLine2Additional address information
                        CityCity portion of the address
                        StateState code of the address
                        ZipCode Zip code portion of the address. US addresses must be of the standard 5 digit or 5-4 digit form
                        CountryCountry code of the address
                        PhoneNumberPhone number for the service contact
                        IsPublicBoolean value to indicate whether this service contact is to be included in the public list
                        IsInFirmMasterList Boolean value to indicate whether this service contact is to be included in the firm's master list.

                        NOTE: Once a service contact is added to the firm master list it cannot be removed from the master list; however, it can be removed from the firm via the RemoveServiceContact API

                        IsMailServiceContactBoolean value to indicate whether this service contact is a mail service contact, and should not receive eService.
                        Outputs
                        FieldDescription
                        ServiceContactIDUnique EFM identifier for the service contact



                        ReplaceServiceContact

                        ReplaceServiceContact replaces an existing service contact with another on a single case, or all of their cases.
                        Version3.7
                        RequiredCore functionality
                        Accessible ToFirm Administrators Only. If CSM is enabled, requires the ManageFirmServiceContacts resource.
                        User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                        ServiceEFMFirmService
                        Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                        Request Message DefinitionReplaceServiceContactRequest
                        Response Message DefinitionBaseResponse
                        XML Samples
                        DescriptionRequestResponse
                        ReplaceServiceContactRequestReplaceServiceContactMessageBaseResponseMessage
                        Inputs
                        FieldDescription
                        OldServiceContactIDThe original service contact ID to be replaced
                        NewServiceContactIDThe new service contact ID to be replace the old ID
                        CaseIDThe internal case ID of the specific case a service contact is being replaced on
                        CasePartyIDCurrently an optional unused value, and should be excluded from requests. Has no effect on the request
                        Outputs
                        FieldDescription
                        No Outputs



                        Using Service Contacts

                        The following APIs allow a user to manage the association of a service contact to a case or a case party. Once associated, the service contact will be included in the results of the GetServiceInformation API for the case.
                          Details regarding the service contact usage APIs are provided below.

                          AttachServiceContact

                          AttachServiceContact creates an association between a service contact and a case or a case party.
                          Version3.7
                          RequiredCore functionality
                          Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelope resource.
                          User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                          ServiceEFMFirmService
                          Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                          Request Message DefinitionAttachServiceContactRequest
                          Response Message DefinitionBaseResponse
                          XML Samples
                          DescriptionRequestResponse
                          AttachServiceContactAttachServiceContactMessageBaseResponseMessage
                          Inputs
                          FieldDescription
                          ServiceContactIDUnique EFM identifier for the service contact
                          CaseIDUnique EFM identifier for the case
                          CasePartyIDUnique EFM identifier for the case party. This element is optional
                          Outputs
                          FieldDescription
                          No Outputs



                          DetachServiceContact

                          DetachServiceContact removes the association between a service contact and a case or case party.
                          Version3.7
                          RequiredCore functionality
                          Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelope resource.
                          User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                          ServiceEFMFirmService
                          Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                          Request Message DefinitionDetachServiceContactRequest
                          Response Message DefinitionBaseResponse
                          XML Samples
                          DescriptionRequestResponse
                          DetachServiceContactDetachServiceContactMessageBaseResponseMessage
                          Inputs
                          FieldDescription
                          ServiceContactIDUnique EFM identifier for the service contact
                          CaseIDUnique EFM identifier for the case
                          CasePartyID Unique EFM identifier for the case party. This element is optional. When provided, the service contact is only removed from the designated case party. When not provided, the service contact is completely removed from the case and all case parties
                          Outputs
                          FieldDescription
                          No Outputs



                          GetPublicList

                          GetPublicList enables the user to search the public list of service contacts. The caller must include at least one of the input parameters. The results will be capped at 100 results.

                          This functionality is used in limited jurisdictions and will be deprecated in a future release. Please inquire with your Tyler eFiling Program Director to determine whether the public list is used in your jurisdiction

                          Version3.7
                          RequiredConditional functionality, subject to business requirements
                          Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                          User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                          ServiceEFMFirmService
                          Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                          Request Message DefinitionGetPublicListRequest
                          Response Message DefinitionServiceContactListResponse
                          XML Samples
                          DescriptionRequestResponse
                          GetPublicListGetPublicListRequestMessageGetPublicListResponseMessage
                          Inputs
                          FieldDescription
                          FirstNameFirst name of the person
                          LastNameLast name of the person
                          FirmNameName of the firm to which the person belongs
                          EmailEmail address of the person
                          Outputs
                          FieldDescription
                          AddByFirmName Name of the firm that added the service contact to the public list at the time the service contact was added.

                          NOTE: See Data Field Configuration Code PublicServiceContactShowFreeFormFirmName

                          FirmName Name of the firm as provided by the person adding the service contact

                          NOTE: See Data Field Configuration Code PublicServiceContactShowFreeFormFirmName

                          FirmIDUnique EFM identifier for the firm
                          ServiceContactIDUnique EFM identifier for the service contact
                          FirstNameFirst name of the service contact
                          MiddleNameMiddle name of the service contact
                          LastNameLast name of the service contact
                          Email Email address for the service contact

                          NOTE: See Data Field Configuration Code PublicServiceContactShowEmail

                          AdministrativeCopy Email address for the administrative copy
                          AddressPhysical address for the service contact
                          PhoneNumberPhone number for the service contact
                          IsPublicBoolean to indicate whether the service contact should appear in the public list
                          IsUndeliverableA read-only boolean indicating whether or not the user's email is deliverable



                          Managing Payment Accounts

                          Payment Accounts are an EFM construct that facilitates the payment of all fees within File & Serve. These fees include EFSP fees, EFM fees, county fees, and statutory fees. Refer to the GetPaymentAccountTypeList API for obtaining the payment account types available. A waiver account is a request to waive all fees. During clerk review, the clerk determines whether a waiver can be accepted, according to court policy.

                          The following APIs provide the ability to manage the firm's payment accounts.

                            Details regarding the payment account management APIs are provided below.

                            GetPaymentAccountTypeList

                            GetPaymentAccountTypeList retrieves a list of the valid payment account types.
                            Version3.7
                            RequiredCore functionality
                            Accessible ToFirm Administrators Only. If CSM is enabled, requires the ViewPayment resource.
                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                            ServiceEFMFirmService
                            Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                            Request Message DefinitionBaseRequest
                            Response Message DefinitionPaymentAccountTypeListResponse
                            XML Samples
                            DescriptionRequestResponse
                            GetPaymentAccountTypeListN/APaymentAccountTypeListResponseMessage
                            Inputs
                            FieldDescription
                            No Inputs
                            Outputs
                            FieldDescription
                            CodeIdUnique identifier for the payment account type
                            CodeCode for the payment account type
                            DescriptionDescription of the payment account type



                            CreatePaymentAccount

                            CreatePaymentAccount enables the firm administrator to create a payment account for the firm. To obtain a list of available payment accounts types, use the GetPaymentAccountTypeList API Credit Card and eCheck Accounts These accounts require a filer to obtain a payment token from the Tyler Online Gateway (TOGA) by registering the filer's account information.

                            Waivers These accounts instruct the e-Filing system that the court has waived fees. The review clerk will determine whether the waiver is valid and accept or reject the filing accordingly.

                            Draw Down Accounts These accounts allow filers to e-File with funds that are on file with the clerk’s office. At present, drawdown accounts are only supported for use with Clerks using Odyssey Case Manager. Filers open and fund a drawdown account directly with the clerk. Such accounts are set up within Odyssey Case Manager for use at one or more court locations, which will result in an account number being provided to the filer. The filer then provides that account number when setting up the account within the EFM, thereby allowing the EFM to validate the account and to obtain the balance and the list of court locations where the account may be used. When a filing is submitted to be paid by drawdown account, the EFM will confirm adequate funds within Odyssey Case Manager. When such filings are accepted by the clerk, the necessary funds will be deducted from the account within Odyssey Case Manager.

                            Cash Accounts These accounts are reserved for use where cash is taken over the counter. By default, anyone can create and use cash accounts, if enabled. It is up to Reviewers to reject filings when they should not be used. Due to this specialty use case, we recommend that EFSPs filter out this payment account type.

                            Version3.7
                            RequiredCore functionality
                            Accessible ToFirm Administrators Only. If CSM is enabled, requires the AddPaymentAccounts resource.
                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                            ServiceEFMFirmService
                            Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                            Request Message DefinitionCreatePaymentAccountRequest
                            Response Message DefinitionCreatePaymentAccountResponse
                            XML Samples
                            DescriptionRequestResponse
                            CreatePaymentAccount - Credit CardCreatePaymentAccountMessageCreatePaymentAccountResponseMessage
                            CreatePaymentAccount - WaiverCreatePaymentAccountMessage - WaiverCreatePaymentAccountResponseMessage
                            CreatePaymentAccount - eCheckCreatePaymentAccountMessage - eCheckCreatePaymentAccountResponseMessage
                            CreatePaymentAccount - eCheckCreatePaymentAccountMessage - DrawDownCreatePaymentAccountResponseMessage - DrawDown
                            Inputs
                            FieldDescription
                            PaymentAccountTypeCodeA payment account type code as defined by the GetPaymentAccountTypeList API
                            AccountNameName displayed for the payment account
                            AccountToken Payment token identifier. Required for Credit Cards, eChecks, and Draw Downs.

                            For Credit Cards and eChecks, this is the PayorToken field returned by TOGA in response to a filer registering a credit card or eCheck account. For Draw Down accounts, this is the value provided by the court when the draw down account was set up.

                            CardType Type of credit card. This is the first part of the TenderDescription field returned by TOGA in response to a filer registering a credit card or eCheck. Required for PaymentAccountTypeCode value of CC or BankAccount
                            CardLast4 Credit card number's last four digits. This is the last four digits of the TenderDescription field returned by TOGA in response to a filer registering a credit card or eCheck account. Required for PaymentAccountTypeCode value of CC or BankAccount
                            CardMonth Credit card's expiration month. This is the ExpirationMonth field returned by TOGA in response to a filer registering a credit card. Required for PaymentAccountTypeCode value of CC Send a value of 0 for eChecks
                            CardYear Credit card's expiration year. This is the ExpirationYear field returned by TOGA in response to a filer registering a credit card. Required for PaymentAccountTypeCode value of CC. Send a value of 0 for eChecks
                            CardHolderName Credit card's cardholder name. This is the PayorName field returned by TOGA in response to a filer registering a credit card or eCheck account. Required for PaymentAccountTypeCode value of CC or BankAccount
                            CourtIdentifier Applicable only for PaymentAccountTypeCode value of DrawDown. Repeat this element for each court location where a drawdown payment account is to be valid for use. If not provided, the payment account will be available for use at all court locations.

                            NOTE: The CMS ultimately governs where the draw down account can be used.

                            Outputs
                            FieldDescription
                            PaymentAccountID Unique EFM identifier for the payment account
                            PaymentAccountLocation Only applies to DrawDown accounts. Provides balance and minimum balance by court location. May repeat for additional court locations.



                            GetPaymentAccountList

                            GetPaymentAccountList enables a firm member to retrieve a list of the firm's payment accounts.
                            Version3.7
                            RequiredCore functionality
                            Accessible ToAny registered user. If CSM is enabled, requires the ViewPayment resource.
                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                            ServiceEFMFirmService
                            Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                            Request Message DefinitionBaseRequest
                            Response Message DefinitionPaymentAccountListResponse
                            XML Samples
                            DescriptionRequestResponse
                            GetPaymentAccountListN/APaymentAccountListResponseMessage
                            Inputs
                            FieldDescription
                            No Inputs
                            Outputs
                            FieldDescription
                            PaymentAccountIDUnique EFM identifier for the payment account
                            FirmIDUnique EFM identifier for the firm the payment account belongs to
                            PaymentAccountTypeCodeThe payment account type code. Valid values returned by the GetPaymentAccountTypeList API
                            AccountNameName displayed for the payment account
                            AccountToken Payment token identifier. This element will be present but empty for waiver accounts.
                            Card Type Possible values:
                            • AMEX
                            • CHECKING
                            • DISCOVER
                            • MASTERCARD
                            • VISA
                            This element will not be present for waiver accounts
                            CardLast4 The last 4 digits of the credit card number or bank account number. This element does not apply to waiver accounts
                            CardMonth Two digit expiration month for the credit card. This element does not apply to eCheck and waiver accounts
                            CardYear Four digit expiration year for the credit card. This element does not apply to eCheck and waiver accounts
                            CardHolderName The name on the credit card or bank account, as obtained from TOGA. This element does not apply to waiver accounts
                            ActiveBoolean indicator as to whether the account is active
                            IsAvailableAtAllLocations Boolean indicator as to whether a drawdown account is avaialble for use at all court locations
                            AvailableLocationNodes One or more LocationNode structures to indicate the court locations where the drawdown account is available



                            GetPaymentAccount

                            GetPaymentAccount enables a firm member to retrieve information about an existing payment account.
                            Version3.7
                            RequiredCore functionality
                            Accessible ToFirm Administrators Only. If CSM is enabled, requires the ViewPayment resource.
                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                            ServiceEFMFirmService
                            Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                            Request Message DefinitionGetPaymentAccountRequest
                            Response Message DefinitionGetPaymentAccountResponse
                            XML Samples
                            DescriptionRequestResponse
                            GetPaymentAccount - Credit CardGetPaymentAccountMessageGetPaymentAccountResponseMessage - Credit Card
                            GetPaymentAccount - eCheckGetPaymentAccountMessageGetPaymentAccountResponseMessage - eCheck
                            GetPaymentAccount - DrawDownGetPaymentAccountMessageGetPaymentAccountResponseMessage - DrawDownWithCourtIdentifier
                            GetPaymentAccount - WaiverGetPaymentAccountMessageGetPaymentAccountResponseMessage - Waiver
                            Inputs
                            FieldDescription
                            PaymentAccountIDUnique EFM identifier for the payment account
                            Outputs
                            FieldDescription
                            PaymentAccountIDUnique EFM identifier for the payment account
                            FirmIDUnique EFM identifier for the firm the payment account belongs to
                            PaymentAccountTypeCodeThe payment account type code. Valid values returned by the GetPaymentAccountTypeList API
                            AccountNameName displayed for the payment account
                            AccountToken Payment token identifier. This element will be present but empty for waiver accounts.
                            Card Type Possible values:
                            • AMEX
                            • CHECKING
                            • DISCOVER
                            • MASTERCARD
                            • VISA
                            This element only applies to credit card and eCheck accounts
                            CardLast4 The last 4 digits of the credit card number or bank account number.
                            CardMonth Two digit expiration month for s credit card.
                            CardYear Four digit expiration year for the credit card.
                            CardHolderName The name on the credit card or bank account, as obtained from TOGA.
                            ActiveBoolean indicator as to whether the account is active
                            CourtIdentifierAn element that will be repeated to represent each court location where this payment account is valid
                            PaymentAccountLocationDetails Provides the current balance and minimum balance for a drawdown account



                            RemovePaymentAccount

                            RemovePaymentAccount removes a payment account.
                            Version3.7
                            RequiredCore functionality
                            Accessible ToFirm Administrators Only. If CSM is enabled, requires the DeletePaymentAccounts resource.
                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                            ServiceEFMFirmService
                            Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                            Request Message DefinitionRemovePaymentAccountRequest
                            Response Message DefinitionBaseResponse
                            XML Samples
                            DescriptionRequestResponse
                            RemovePaymentAccountRemovePaymentAccountMessageBaseResponseMessage
                            Inputs
                            FieldDescription
                            PaymentAccountIDUnique EFM identifier for the payment account
                            Outputs
                            FieldDescription
                            No Outputs



                            UpdatePaymentAccount

                            UpdatePaymentAccount provides the ability to update the account name or active flag for an existing payment account. While the other payment account fields cannot be modified, they must still be provided in the message in order to satisfy schema requirements. A new payment account should be created in order to accommodate new credit card or bank account details.
                            Version3.7
                            RequiredCore functionality
                            Accessible ToFirm Administrators Only. If CSM is enabled, requires the EditPaymentAccounts resource.
                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                            ServiceEFMFirmService
                            Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                            Request Message DefinitionUpdatePaymentAccountRequest
                            Response Message DefinitionUpdatePaymentAccountResponse
                            XML Samples
                            DescriptionRequestResponse
                            UpdatePaymentAccountUpdatePaymentAccountMessageUpdatePaymentAccountResponseMessage
                            UpdatePaymentAccountUpdatePaymentAccountMessage - DrawDownUpdatePaymentAccountResponseMessage - DrawDown
                            Inputs
                            FieldDescription
                            PaymentAccountIDUnique EFM identifier for the payment account
                            AccountNameName displayed for the payment account
                            AccountToken An account access token provided by the clerk
                            CourtIdentifier Applicable only for PaymentAccountTypeCode value of DrawDown. Repeat this element for each court location where a drawdown payment account is to be valid for use. Any court locations provided will replace any locations previously associated with the payment account. If not provided, the payment account will be available for use at all court locations.

                            NOTE: The CMS ultimately governs where the draw down account can be used.

                            ActiveBoolean indicator as to whether the account is active
                            Outputs
                            FieldDescription
                            PaymentAccountIDUnique EFM identifier for the payment account
                            PaymentAccountLocation Only applies to DrawDown accounts. Provides balance and minimum balance by court location. May repeat for additional court locations.



                            Global Payment Accounts

                            The following APIs provide the EFSP the ability to manage global payment accounts. The purpose of a global payment account is to extend credit to the EFSP's firms.

                            While a regular payment account is specific to a particular firm, a global payment account is specific only to a particular EFSP - it is not associated with a particular firm. Therefore, the EFSP can use a global payment account to register a credit card or bank account that is owned by the EFSP, then allow firms to use that global payment account.

                            The EFM allows the global payment account to be used for any filings submitted from the EFSP who owns the account. The EFSP is responsible for determining which firms are allowed to submit filings with the global payment account. The EFSP is also responsible for invoicing/billing/collecting from the firms for use of the payment account.

                              Details regarding the global payment account management APIs are provided below.

                              CreateGlobalPaymentAccount

                              CreateGlobalPaymentAccount enables an EFSP to create a global payment account. The message definitions for this API are identical to CreatePaymentAccount.
                              Version3.7
                              RequiredConditional functionality, subject to business requirements
                              Accessible ToEFSP initiates this call with no user context
                              User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                              ServiceEFMFirmService
                              Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                              Request Message DefinitionCreatePaymentAccountRequest
                              Response Message DefinitionCreatePaymentAccountResponse
                              XML Samples
                              DescriptionRequestResponse
                              CreatePaymentAccount - Credit CardCreatePaymentAccountMessageCreatePaymentAccountResponseMessage
                              CreatePaymentAccount - WaiverCreatePaymentAccountMessage - WaiverCreatePaymentAccountResponseMessage
                              CreatePaymentAccount - eCheckCreatePaymentAccountMessage - eCheckCreatePaymentAccountResponseMessage
                              Inputs
                              FieldDescription
                              *** Refer to the CreatePaymentAccount API ***
                              Outputs
                              FieldDescription
                              *** Refer to the CreatePaymentAccount API ***



                              GetGlobalPaymentAccountList

                              GetGlobalPaymentAccountList enables an EFSP to retrieve a list of their global payment accounts. The message definitions for this API are identical to GetPaymentAccountList
                              Version3.7
                              RequiredConditional functionality, subject to business requirements
                              Accessible ToEFSP initiates this call with no user context
                              User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                              ServiceEFMFirmService
                              Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                              Request Message DefinitionBaseRequest
                              Response Message DefinitionPaymentAccountListResponse
                              XML Samples
                              DescriptionRequestResponse
                              GetGlobalPaymentAccountListN/APaymentAccountListResponseMessage
                              Inputs
                              FieldDescription
                              *** Refer to the GetPaymentAccountList API ***
                              Outputs
                              FieldDescription
                              *** Refer to the GetPaymentAccountList API ***



                              GetGlobalPaymentAccount

                              GetGlobalPaymentAccount enables an EFSP to retrieve information about an existing global payment account. The message definitions for this API are identical to GetPaymentAccount.
                              Version3.7
                              RequiredConditional functionality, subject to business requirements
                              Accessible ToEFSP initiates this call with no user context
                              User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                              ServiceEFMFirmService
                              Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                              Request Message DefinitionGetPaymentAccountRequest
                              Response Message DefinitionGetPaymentAccountResponse
                              XML Samples
                              DescriptionRequestResponse
                              GetPaymentAccount - Credit CardGetPaymentAccountMessageGetPaymentAccountResponseMessage - Credit Card
                              GetPaymentAccount - eCheckGetPaymentAccountMessageGetPaymentAccountResponseMessage - eCheck
                              GetPaymentAccount - WaiverGetPaymentAccountMessageGetPaymentAccountResponseMessage - Waiver
                              Inputs
                              FieldDescription
                              *** Refer to the GetPaymentAccount API ***
                              Outputs
                              FieldDescription
                              *** Refer to the GetPaymentAccount API ***



                              RemoveGlobalPaymentAccount

                              RemoveGlobalPaymentAccount enables an EFSP to remove a global payment account. The message definitions for this API are identical to RemovePaymentAccount.
                              Version3.7
                              RequiredConditional functionality, subject to business requirements
                              Accessible ToEFSP initiates this call with no user context
                              User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                              ServiceEFMFirmService
                              Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svc
                              Request Message DefinitionRemovePaymentAccountRequest
                              Response Message DefinitionBaseResponse
                              XML Samples
                              DescriptionRequestResponse
                              RemoveGlobalPaymentAccountRemovePaymentAccountMessageBaseResponseMessage
                              Inputs
                              FieldDescription
                              *** Refer to the RemovePaymentAccount API ***
                              Outputs
                              FieldDescription
                              *** Refer to the RemovePaymentAccount API ***



                              UpdateGlobalPaymentAccount

                              UpdateGlobalPaymentAccount provides the ability to update the account name or active flag for an existing global payment account. While the other payment account fields cannot be modified, they must still be provided in the message in order to satisfy schema requirements. A new payment account should be created in order to accommodate new credit card details.
                              Version3.7
                              RequiredConditional functionality, subject to business requirements
                              Accessible ToEFSP initiates this call with no user context
                              User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                              ServiceEFMFirmService
                              Sample URLhttps://court.tylertech.cloud/efm/EFMFirmService.svcw
                              Request Message DefinitionUpdatePaymentAccountRequest
                              Response Message DefinitionUpdatePaymentAccountResponse
                              XML Samples
                              DescriptionRequestResponse
                              UpdatePaymentAccountUpdatePaymentAccountMessageUpdatePaymentAccountResponseMessage
                              Inputs
                              FieldDescription
                              *** Refer to the UpdatePaymentAccount API ***
                              Outputs
                              FieldDescription
                              *** Refer to the UpdatePaymentAccount API ***



                              User Self-Management

                              The EFM User Service allows an existing user to authenticate with the system as well as to manage his/her account.
                                Details regarding each user self-management API are provided below.

                                AuthenticateUser

                                AuthenticateUser authenticates a user's credentials within the EFM. The EFM will return a unique value that the EFSP should then use in lieu of the user's password for subsequent interactions with the EFM on behalf of the user. This eliminates the need for the EFSP to store a user's human readable password.

                                Five failed attempts to log in within a ten-minute timeframe triggers a lock on the associated account. Once locked, an account can be unlocked via either of these actions:

                                NOTE: You only need to call this API when seeking verification of user provided credentials in order to obtain a PasswordHash from the EFM. Once successful, you need not call this API again until either the user attempts a subsequent sign on, or the existing PasswordHash expires (error code -4)

                                Version3.7
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUnauthenticated call - No credentials necessary
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionAuthenticateRequest
                                Response Message DefinitionAuthenticateResponse
                                XML Samples
                                DescriptionRequestResponse
                                AuthenticateUserAuthenticateRequestMessageAuthenticateResponseMessage
                                Inputs
                                FieldDescription
                                EmailEmail address of the user account
                                Password Password for the account

                                NOTE: When Okta is enabled for authentication, this element should contain the JWT returned from Okta instead of a user provided password.
                                Outputs
                                FieldDescription
                                UserIDUnique EFM identifier for the user account
                                EmailEmail address of the user account
                                FirstNameFirst name of the user
                                LastNameLast name of the user
                                PasswordHash Unique value assigned to the user by the EFM for subsequent interactions with the EFM. While the value is actually a GUID, the concept is similar to a password hash for the user
                                ExpirationDateTimeUTC date/time when the PasswordHash will expire



                                ChangePassword

                                ChangePassword enables the user to change their password within the EFM


                                NOTE: This API is deprecated when Okta is enabled for the site. Refer to the GetPolicy API.

                                Version3.7
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionChangePasswordRequest
                                Response Message DefinitionChangePasswordResponse
                                XML Samples
                                DescriptionRequestResponse
                                ChangePasswordChangePasswordMessageChangePasswordResponseMessage
                                Inputs
                                FieldDescription
                                OldPasswordCurrent clear-text password for the user
                                NewPasswordNew clear-text password for the user
                                PasswordQuestion NOTE: The password reset question/answer is deprecated in version 3.14; however, this API will continue to accept the fields in order to preserve backward compatibility.

                                Question to ask during password reset process

                                PasswordAnswer NOTE: The password reset question/answer is deprecated in version 3.14; however, this API will continue to accept the fields in order to preserve backward compatibility.

                                Answer to expect during password reset process

                                Outputs
                                FieldDescription
                                PasswordHash Unique value assigned to the user by the EFM for subsequent interactions with the EFM. While the value is actually a GUID, the concept is similar to a password hash for the user
                                ExpirationDateTimeUTC date/time when the PasswordHash will expire



                                GetPasswordQuestion

                                NOTE: The GetPasswordQuestion API is deprecated in v3.14; however the API will continue functioning in order to provide backward compatibility. Please phase out the use of this API prior to the release of 3.15

                                GetPasswordQuestion retrieves the previously set password reset question for a user.

                                Version3.7
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionGetPasswordQuestionRequest
                                Response Message DefinitionPasswordQuestionResponse
                                XML Samples
                                DescriptionRequestResponse
                                GetPasswordQuestionGetPasswordQuestionMessagePasswordQuestionResponseMessage
                                Inputs
                                FieldDescription
                                EmailEmail address of the firm user
                                Outputs
                                FieldDescription
                                PasswordQuestionQuestion previously set for password reset



                                ResetPassword

                                ResetPassword enables a user to reset their password. This API triggers an email to the user's email address. This email includes a hyperlink whereby they can set a new password.
                                Version3.7
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUnauthenticated call - No credentials necessary
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionResetPasswordRequest
                                Response Message DefinitionResetPasswordResponse
                                XML Samples
                                DescriptionRequestResponse
                                ResetPasswordResetPasswordMessageResetPasswordResponseMessage
                                Inputs
                                FieldDescription
                                EmailEmail address of the user requesting a password reset
                                PasswordAnswer NOTE: This field is deprecated in version 3.14. The EFM no longer requires a value and will ignore any value that is sent in.

                                Answer previously set to the user's password reset question

                                Outputs
                                FieldDescription
                                PasswordHash Unique value assigned to the user by the EFM for subsequent interactions with the EFM. While the value is actually a GUID, the concept is similar to a password hash for the user



                                GetUser (User Service)

                                GetUser enables a user to retrieve information about his/her own user account.
                                Version3.7
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionGetUserRequest
                                Response Message DefinitionGetUserResponse
                                XML Samples
                                DescriptionRequestResponse
                                GetUserGetUserMessageGetUserResponseMessage
                                Inputs
                                FieldDescription
                                UserIDUnique EFM identifier for the user account
                                Outputs
                                FieldDescription
                                UserIDUnique EFM identifier for the user account
                                EmailEmail address for the user
                                FirstNameFirst name of the user
                                MiddleNameMiddle name of the user
                                LastNameLast name of the user
                                LastLoginDateDate and timestamp when the user last logged into the system via the AuthenticateUser API
                                Role NOTE: This element will not be emitted when the Composable Security Model is enabled on the site. The GetPolicy API indicates whether this is enabled.

                                This element repeats as needed to indicate the roles granted to this user. The Filer, FirmAdmin, and CriminalFilingFirmAdmin roles apply system-wide whereas the CriminalFilingFiler is assigned at specific locations.

                                RestrictFilingA read-only boolean indicating whether the user's ability to submit filings has been administratively restricted by Tyler
                                RestrictFilingCommentA read-only description of why the user's ability to submit filing has been restricted
                                IsUndeliverableA read-only boolean indicating whether or not the user's email is deliverable



                                UpdateUser (User Service)

                                UpdateUser updates the email and name information for a user.
                                Version3.7
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionUpdateUserRequest
                                Response Message DefinitionUpdateUserResponse
                                XML Samples
                                DescriptionRequestResponse
                                UpdateUserUpdateUserMessageUpdateUserResponseMessage
                                Inputs
                                FieldDescription
                                UserIDUnique EFM identifier for the user account
                                FirstNameFirst name of the user
                                MiddleNameMiddle name of the user
                                LastNameLast name of the user
                                EmailEmail address of the user
                                Outputs
                                FieldDescription
                                UserIDUnique EFM identifier for the user account



                                GetNotificationPreferences

                                GetNotificationPreferences enables the user to obtain their current subscriptions to the EFM's notification emails.
                                Version3.9
                                RequiredConditional functionality, subject to business requirements
                                Accessible ToAny registered user
                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionBaseRequest
                                Response Message DefinitionNotificationPreferencesResponse
                                XML Samples
                                DescriptionRequestResponse
                                GetNotificationPreferencesN/AGetNotificationPreferencesResponse
                                Inputs
                                FieldDescription
                                No Inputs
                                Outputs
                                FieldDescription
                                ACCEPTEDIndicates whether the EFM will notify when a filing is accepted by the court
                                ACCOUNTLOCKEDIndicates whether the EFM will notify when the user's account has been locked
                                RECEIPTEDIndicates whether the EFM will notify when a filing is receipted by the court. This is not a monetary receipt, but rather, a special purpose form of acceptance of a filing that a jurisdiction may elect to employ
                                REJECTEDIndicates whether the EFM will notify when a filing is rejected, either by the EFM or the court
                                RETURNFORCORRECTIONIndicates whether the EFM will notify when a filing has been returned for correction by the court
                                SERVICEUNDELIVERABLEIndicates whether the EFM will notify when an attempted service cannot be delivered
                                SUBMISSIONFAILEDIndicates whether the EFM will notify when a filing is fails in submission to the EFM
                                SUBMITTEDIndicates whether the EFM will notify when a filing is successfully submitted to the EFM
                                SUBMITTEDBULKSUMMARYIndicates whether the EFM will notify when a bulk filing is successfully submitted to the EFM



                                UpdateNotificationPreferences

                                UpdateNotificationPreferences enables a user to subscribe/unsubscribe with the EFM to control which notification emails should be sent.
                                Version3.9
                                RequiredConditional functionality, subject to business requirements
                                Accessible ToAny registered user
                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionUpdateNotificationPreferencesRequest
                                Response Message DefinitionBaseResponse
                                XML Samples
                                DescriptionRequestResponse
                                UpdateNotificationPreferencesUpdateNotificationPreferencesBaseResponseMessage
                                Inputs
                                FieldDescription
                                ACCEPTEDIndicates whether the EFM will notify when a filing is accepted by the court
                                ACCOUNTLOCKEDIndicates whether the EFM will notify when the user's account has been locked
                                RECEIPTEDIndicates whether the EFM will notify when a filing is receipted by the court. This is not a monetary receipt, but rather, a special purpose form of acceptance of a filing that a jurisdiction may elect to employ
                                REJECTEDIndicates whether the EFM will notify when a filing is rejected, either by the EFM or the court
                                RETURNFORCORRECTIONIndicates whether the EFM will notify when a filing has been returned for correction by the court
                                SERVICEUNDELIVERABLEIndicates whether the EFM will notify when an attempted e-service cannot be delivered
                                SUBMISSIONFAILEDIndicates whether the EFM will notify when a filing is fails in submission to the EFM
                                SUBMITTEDIndicates whether the EFM will notify when a filing is successfully submitted to the EFM
                                SUBMITTEDBULKSUMMARYIndicates whether the EFM will notify when a bulk filing is successfully submitted to the EFM
                                Outputs
                                FieldDescription
                                No Outputs



                                SelfResendActivationEmail

                                SelfResendActivationEmail allows a user to trigger the re-send of the user activation email.
                                Version3.14
                                RequiredCore functionality
                                Accessible ToAny registered user
                                User CredentialsUnauthenticated call - No credentials necessary
                                ServiceEFMUserService
                                Sample URLhttps://court.tylertech.cloud/efm/EFMUserService.svc
                                Request Message DefinitionSelfResendActivationEmailRequest
                                Response Message DefinitionBaseResponse
                                XML Samples
                                DescriptionRequestResponse
                                AuthenticateUserSelfResendActivationEmailRequestBaseResponseMessage
                                Inputs
                                FieldDescription
                                EmailEmail address of the user account
                                Outputs
                                FieldDescription
                                No Outputs



                                E-Filing APIs

                                E-Filing APIs are implemented according to the ECF Major Design Elements (MDEs) and Tyler extensions of the ECF MDEs.
                                  Access Control
                                  These APIs require signed SOAP headers to provide system to system authentication. Sample .NET/WCF code is available here.

                                  ECF includes an ErrorCodeText element for returning errors in response to a request. Successful queries return an ErrorCodeText of 0. Failed queries return an appropriate ErrorCodeText value as defined in the court policy.

                                  Additional details for each API are provided below.

                                  Court Policy MDE Service

                                  The Court Policy MDE Service includes a single API that enables the EFSP to query court policy.
                                    Details regarding this API are provided below.

                                    GetPolicy

                                    GetPolicy retrieves the machine-readable court policy, which contains a list of base URLs whereby court specific codes can be obtained, as well as EFM behavioral characteristics.
                                    Version2022.0
                                    RequiredCore functionality
                                    Accessible ToAny registered user
                                    User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                    ServiceCourtPolicyMDEService
                                    Sample URLhttps://court.tylertech.cloud/efm/v5/courtpolicyservice.svc
                                    Request Message Definitionpolicyrequest
                                    Response Message Definitionpolicyresponse
                                    XML Samples
                                    DescriptionRequestResponse
                                    GetPolicytyler-policyrequesttyler-policyresponse
                                    Inputs
                                    FieldDescription
                                    Court Location The OrganizationIdentification/IdentificationID element must contain a valid Court Location Identifier, which identifies the court location for which the court policy is desired. The valid values are defined by configuration. Refer to Court Locations codes.
                                    /policyrequest:GetPolicyRequestMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                    Outputs
                                    FieldDescription
                                    Code Fields Defines the code fields used within the EFM. ECFElementNameText specifies the element name within the ECF messages where the codified field will be stored. ExtensionLocationURI contains the URL whereby the valid list of code values may be obtained from the EFM. Please refer to the Configuration section of this API Reference Guide for more information about each code table.
                                    /policyresponse:GetPolicyResponseMessage/policyresponse:RuntimePolicy/policyresponse:CodeListExtension
                                    Maximum Document SizeDefines the maximum size for any single document that may be submitted with a filing. The size is enforced upon the file in its native form (e.g. PDF, not base64 encoded)
                                    /policyresponse:GetPolicyResponseMessage/policyresponse:DevelopmentPolicy/policyresponse:MaximumAllowedAttachmentSize
                                    Maximum Message SizeDefines the maximum total size for all documents that may be submitted with an envelope. The size is enforced upon the file in its native form (e.g. PDF, not base64 encoded)
                                    /policyresponse:GetPolicyResponseMessage/policyresponse:DevelopmentPolicy/policyresponse:MaximumAllowedMessageSize
                                    SupportedCaseCategoriesSpecifies with ECF case types are supported at this court location
                                    /policyresponse:GetPolicyResponseMessage/policyresponse:DevelopmentPolicy/policyresponse:SupportedCaseCategories
                                    Schema Extensions Specifies Tyler's extensions to the ECF schemas
                                    /policyresponse:GetPolicyResponseMessage/policyresponse:DevelopmentPolicy/policyresponse:SchemaExtension
                                    Session Timeouts This pair of values defines the expiration model for user password GUIDs. TimeoutMinutes defines the number of minutes before a user password GUID will be subject to timeout. TimeoutResetHour defines the UTC time of day when GUID timeouts will take effect.

                                    Example:
                                    TimeoutMinutes = 1440 (24 hours)
                                    TimeoutResetHour = 02:00:00Z

                                    - A password GUID issued at 01:59:00Z will be valid for 1441 minutes (24 hours and 1 minute).
                                    - A password GUID issued at 02:01:00Z will be valid for 2879 minutes (47 hours and 59 minutes).

                                    NOTE: This configuration drives the expiration but the EFM emits the actual expiration for each GUID upon issuance.
                                    /policyresponse:GetPolicyResponseMessage/tylercommon:GetPolicyResponseMessageAugmentation/tylercommon:TimeoutMinutes
                                    /policyresponse:GetPolicyResponseMessage/tylercommon:GetPolicyResponseMessageAugmentation/tylercommon:TimeoutResetHour

                                    Court URL A URL that leads to the court's website or e-Filing information.
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:LocationSpecificURI
                                    UseComposableSecurity A boolean that indicates whether the Composable Security Model is in use. If true, the Composable Security Model micro-service is in use. If false, the EFM is responsible for user access management (legacy model).
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:UseComposableSecurity
                                    ComposableSecurityURI Provides the endpoint for the Composable Security Model micro-service.
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:ComposableSecurityURI
                                    ComposableSecurityTenant For use with Tyler's multi-tenant micro-services, this provides the tenant ID corresponding to this EFM site
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:ComposableSecurityTenant/nc:IdentificationID
                                    ComposableSecurityDefaultRole Provides a role which the EFM will automatically assign to a user who registers with RegistrationType of FirmAdministrator or Individual. This element will repeat if more than one role is to be assigned.

                                    The EFM does not automatically assign any roles for users registered with RegistrationType of FirmAdminNewMember.
                                    IdentificationID provides the unique roleKey
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:ComposableSecurityDefaultRole/nc:IdentificationID

                                    UseOktaAuthentication A boolean that indicates whether Okta integration is in use. If true, Okta is used for user authentication and account management. If false, the EFM is responsible for user authentication and account management (legacy model).
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:UseOktaAuthentication
                                    OktaAuthenticationURI Provides the Okta endpoint
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:OktaAuthenticationURI
                                    UseNotificationCenter Boolean that indicates if the Notification Center is enabled at this location
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:UseNotificationCenter
                                    NotificationCenterURI Provides the Notification Center endpoint
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:NotificationCenterURI
                                    NotificationCenterVersion The version of the available Notification Center
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:UseNotificationCenter
                                    Tenant The Identifier of the active Tenant
                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation/common:Tenant/nc:IdentificationID
                                    BlackoutStatus When a court location is in a blackout, the following will be returned:
                                    • ReasonDescriptionText - the reason entered for the blackout
                                    • BlackoutDate - the Start and End dates

                                    /policyresponse:GetPolicyResponseMessage/common:GetPolicyResponseMessageAugmentation



                                    Filing Review MDE Service

                                    The Filing Review MDE Service contains APIs that enable the EFSP to calculate fees for potential filings, submit and cancel filings, and query the status of filings.
                                      Details regarding the Filing Review MDE APIs are provided below.

                                      GetFeesCalculation

                                      GetFeesCalculation submits an envelope for the purpose of calculating fees. The envelope's filings are not actually filed with the Court. There is no need to include the document binaries in the message. The calculated fees include statutory court costs and fees, along with applicable e-filing fees and payment processing convenience fees. The request message is a FilingMessage. Please refer to ReviewFiling for more details about the FilingMessage.
                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelopes resource.
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfeesrequest
                                      payment
                                      appellate
                                      bankruptcy
                                      citation
                                      civil
                                      criminal
                                      domestic
                                      juvenile
                                      common
                                      feesresponse
                                      Response Message Definition
                                      XML Samples
                                      DescriptionRequestResponse
                                      Fees Request Messagetyler-feesrequesttyler-feesresponse
                                      GetFeesCalculation - Initial Filingtyler-getfeescalculationtyler-feesresponse
                                      GetFeesCalculation - Subsequent Filingtyler-subsequent-feesrequesttyler-feesresponse
                                      GetFeesCalculation - Initial Filing - MPRFFtyler-mprff-feesrequesttyler-feesresponse
                                      GetFeesCalculation - Subsequent Filing - MPRFFtyler-subsequent-mprff-feesrequesttyler-feesresponse
                                      GetFeesCalculation - Initial Filing - Service Consenttyler-getfeescalculation-service-consenttyler-feesresponse
                                      Inputs
                                      FieldDescription
                                      *** Refer to the ReviewFiling API ***
                                      Page Count A count of the number of pages in the document. This value is used for calculating the filing fee in some jurisdictions. The EFSP must pass this value since document binaries are not sent to the EFM.

                                      NOTE: This field is not necessary for ReviewFiling as the EFM will count the pages in the document binaries

                                      /feesrequest:GetFeesCalculationRequestMessage/filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/common:AttachmentAugmentation/common:PageCount

                                      Outputs
                                      FieldDescription
                                      Court Location The court location identifier
                                      /feesresponse:GetFeesCalculationResponseMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Fees An AllowanceCharge structure represents a fee. Repeats for each fee applicable to the filing. Some fees do not apply in all markets. AllowanceChargeReason provides a description of the fee. Amount provides the fee amount. Some fees include additional elements to provide more information.
                                      /feesresponse:GetFeesCalculationResponseMessage/cac:AllowanceCharge/cbc:AllowanceChargeReason
                                      /feesresponse:GetFeesCalculationResponseMessage/cac:AllowanceCharge/cbc:Amount



                                      The AllowanceChargeReason values are listed below, along with any additional context.

                                      Case Initiation FeeCourt fees associated with case initiation
                                      Party Fee Court fees associated with the addition of a party. ID providces the Party type code
                                      /feesresponse:GetFeesCalculationResponseMessage/cac:AllowanceCharge/cbc:ID
                                      Filing Fee Filing fees associated with the filing. ID provides the Filing code
                                      /feesresponse:GetFeesCalculationResposnseMessage/cac:AllowanceCharge/cbc:ID
                                      Optional Service Fee Court fees for any optional services selected by the filer ID provides the Filing code for the associated services. MultiplierFactorNumeric provides the fee multiplier. PerUnitAmount provides the amount per instance of the fee.
                                      /feesresponse:GetFeesCalculationResponseMessage/cac:AllowanceCharge/cbc:ID
                                      /feesresponse:GetFeesCalculationResponseMessage/cac:AllowanceCharge/cbc:MultiplierFactorNumeric
                                      /feesresponse:GetFeesCalculationResponseMessage/cac:AllowanceCharge/cbc:PerUnitAmount
                                      Mail Service Fee A mail service fee associated with a filing. This occurs when the service type is mail or certified mail.
                                      Process Server Base Fee Service of Process Provider Fees
                                      This is added for each Service of Process on the Envelope.
                                      Process Server Supplemental Fee Service of Process Special Behavior Fees
                                      This is added for each Service of Process on the Envelope.
                                      Total Service FeesEFM Fees
                                      Total Service Tax FeesTax on the EFM fees
                                      Redaction FeeRedaction fee associated with a document
                                      Total Redaction FeesTotal redaction fees associated with a filing
                                      Convenience FeePayment processing fees
                                      Total Provider Service FeesEFSP Fees
                                      Total Provider Tax FeesTax on the EFSP fees
                                      Total Court Service FeesThe county cost recovery fee for e-filing
                                      Total Mail Service FeesTotal of all mail service fees
                                      Total Fees The total amount of fees calculated
                                      /feesresponse:GetFeesCalculationResponseMessage/feesresponse:FeesCalculationAmount/nc:Amount



                                      ReviewFiling

                                      ReviewFiling submits a filing to the court. A filing can be an initial filing (filing a new case) or a subsequent filing (filing into an existing case). Before assembling a subsequent filing, the EFSP system should always call                                       GetCaseList and GetCase first in order to load the latest information for the case. A subsequent filing can be used to add parties to a case, or to add attorneys to existing parties; however, it cannot be used to edit existing party information or to change existing attorney assignments, including pro se.

                                      The ReviewFiling request is a compound message that includes both a FilingMessage and a PaymentMessage. The FilingMessage may be repeated to represent more than one filing in an envelope, as long as they pertain to the same court case. The PaymentMessage represents the method of payment for the envelope, and should include an EFSP fee amount and a corresponding EFSP sales tax amount if such fees are to be charged. The EFSP is responsible for calculating the EFSP sales tax amount.

                                      For courts that lack a full integration with the EFM, cases that did not originate through the e-filing system will not initially be known to the EFM. These are known as non-indexed cases. However, a filer can still electronically file into a non-indexed case. Refer to Locations for relevant attribution. Once such a filing has been accepted by the court, the case will become indexed and thus, retrievable via the EFM's GetCaseList and GetCase mechanisms.

                                      The system includes several fields that are intended for batch filing purposes. This functionality has dependencies beyond the EFM, therefore this capability is reserved to limited jurisdictions that have contracted for this additional capability.

                                      This section includes elements of the filing message that apply regardless of case type. See also

                                      NOTE: Currently, the EFM only supports Citations in conjunction with a corresponding Criminal case.

                                      The EFM asynchronously invokes the NotifyFilingReviewComplete API for each filing as a callback to the EFSP to communicate the outcome of each filing.

                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelopes resource.
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfiling
                                      payment
                                      appellate
                                      bankruptcy
                                      citation
                                      civil
                                      criminal
                                      domestic
                                      juvenile
                                      common
                                      taxdelinquency
                                      Response Message Definitioncbrn
                                      XML Samples
                                      DescriptionRequestResponse
                                      Filing Message for Appellate Case Initiationtyler-initial-appellate-filingmessageN/A
                                      Filing Message for Civil Case Initiationtyler-initial-civil-filingmessageN/A
                                      Filing Message for Civil Case Initiation With Service Associationtyler-initial-civil-filingmessage-service-associationN/A
                                      Filing Message for Civil Tax Case Initiationtyler-initial-civil-tax-filingmessageN/A
                                      Filing Message for Criminal Citation Case Initiationtyler-initial-criminal-citation-filingmessageN/A
                                      Filing Message for Criminal Case Initiationtyler-initial-criminal-filingmessageN/A
                                      Filing Message for Civil Subsequent Filingtyler-subsequent-civil-filingmessageN/A
                                      Payment Messagetyler-paymentmessageN/A
                                      ReviewFilingtyler-reviewfilingtyler-reviewfiling-response
                                      ReviewFiling for Multiple Parties Responsible for Feestyler-initial-civil-filingmessage-mprffN/A
                                      ReviewFiling for eService Consenttyler-initial-civil-filingmessage-eservice-consentN/A
                                      ReviewFiling for RepCaptyler-initial-civil-filingmessage-repcapN/A
                                      ReviewFiling with Kiosk Filer informationtyler-initial-civil-filingmessage-kiosk-emailN/A
                                      ReviewFiling with an Ad Hoc Hearingtyler-initial-civil-filingmessage-adhoc-hearingN/A
                                      ReviewFiling with Service of Processtyler-initial-civil-filingmessage-service-associationN/A
                                      Inputs
                                      FieldDescription
                                      Service Contact Indicates that a service contact should receive service. The ServiceRecipient's ID attribute provides an identifier that can be used to reference the service contact elsewhere within the message. The ServiceContactID element provides the EFM identifier for the service contact. The CaseRepresentedParty element is used to associate the service contact to a party on a case. If not associated to a particular party then the service contact is attached to the case. This ServiceRecipient structure is repeated for each service contact to receive service.

                                      The ServiceTypeCode eleement identifies the Service Type code. If the service method is not specified it will default to e-service. The service contact record must have the information necessary to complete the type of service requested, otherwise the EFM will reject the submission.
                                      /filing:FilingMessage/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/@structures:id
                                      /filing:FilingMessage/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/tylercommon:ServiceContactID/nc:IdentificationID
                                      /filing:FilingMessage/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/ecf:CaseRepresentedParty
                                      /filing:FilingMessage/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/tylercommon:ServiceContactID/tylercommon:ServiceTypeCode

                                      Additional Document Represents any additional documents assocated to a filing. Use PrimaryDocument to reference to associate the document to the appropriate filing May be repeated to represent multiple documents but is subject to court policy document and total envelope size constraints. Refer to the GetPolicy API for more information.
                                      /filing:FilingMessage/filing:FilingConnectedDocument
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/nc:DocumentAssociation/nc:PrimaryDocument
                                      Document and Document Metadata The DocumentRendition/Attachment structure represents a document - a digital file such as a PDF.
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                      Filing Component A valid FilingComponent code
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                      Page Count The number of pages in the document
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                      Filename The filename of the document Subject to constraints set via the OriginalFileName data field configuration code


                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName

                                      Is Redacted Indicates whether the document has been redacted
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                      Document Binary The document in base64 encoded format.
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:Base64BinaryObject
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:Base64BinaryObject
                                      Document Description The filer provided description of the document
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                      File Size The size of the document file
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                      Document TypeA valid Document Type code
                                      /filing:FilingMessage/filing:FilingConnectedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                      Filing FilingLeadDocument represents a filing within an envelope. Repeat as necessary to represent additional filings within the envelope.
                                      /filing:FilingMessage/filing:FilingLeadDocument
                                      Filing Description The filing description as provided by the filer. This field is governed by the DocumentDescription data field configuration code
                                      /filing:FilingMessage/filing:FilingLeadDocument/nc:DocumentDescriptionText
                                      Reference Number The filer's reference number
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:FilerReferenceNumber
                                      Date Filed The date the filing was submitted
                                      /filing:FilingMessage/filing:FilingLeadDocument/nc:DocumentFiledDate/nc:DateTime
                                      Filing Sequence ID A zero based sequence number that is incremented for each filing in the envelope
                                      /filing:FilingMessage/filing:FilingLeadDocument/nc:DocumentSequenceID
                                      Filing Code A valid Filing code
                                      /filing:FilingMessage/filing:FilingLeadDocument/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
                                      Filing Action Determines the action for the filing (EFile, EFileAndServe, Serve). All three actions are valid for the ReviewFiling API. The ServeFiling API assumes a FilingAction of Serve, therefore any other action will be ignored.

                                      If no FilingAction is provided, the original default behavior applies. That is:

                                      • ReviewFiling API without service contacts - EFile
                                      • ReviewFiling API with service contacts - EFileAndServe
                                      • ServeFiling API - Serve
                                      NOTE: The service contacts are still specified at the envelope level, so any filings to serve will be served to the same service contacts
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:FilingAction
                                      Party to Filing Association The business scenarios for this capability vary by jurisdiction. Represents a relationship between a case party to a specific filing in the envelope. This structure can be repeated as necessary to reflect multiple relationships. This field is governed by the FilingEventCaseParties data field configuration code
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:FilingAssociation/tylercommon:PartyReference
                                      Optional Service IdentificationID must contain a valid OptionalServices code

                                      MultiplierAmount provides a fee multiplier for the optional service. A value must be provided if the optional services code is configured to require a multiplier. Refer to Optional Services Codes for more details.

                                      Amount contains a filer provided fee amount. A value must be provided if the optional services code is configured to use a fee prompt. Refer to Optional Services Codes for more details.
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/nc:IdentificationID
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tylercommon:MultiplierAmount
                                      /filing:FilingMessage/filing:FilingLeadDocument/tyler:DocumentAugmentation/tyler:DocumentOptionalService/tyler:ServiceFeeAmount/nc:Amount

                                      If using a configured Optional Service code, multiple parties may be responsible for fees (MPRFF) in which Party Payor will contain their PartyReference, WaiverIndicator, and PaymentAccountID.
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tyler:PartyPayor/tyler:PartyReference
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tyler:PartyPayor/tyler:WaiverIndicator
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tyler:PartyPayor/tyler:PaymentAccountID

                                      Filing Comment Filer's comments regarding the filing
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:FilingCommentsText
                                      Courtesy Copies A comma separated list of email addresses to receive a notification email (with a link to the documents) after the filing is accepted
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:CourtesyCopiesText
                                      Preliminary Copies A comma separated list of email addresses to receive a notification email (with a link to the documents) upon submission of the filing
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:PreliminaryCopiesText
                                      Motion Type A valid Motion Type Code
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:MotionTypeCode
                                      Redaction Identification Associates a filing with a document identifier that has been submitted to the Tyler redaction solution for redaction. The document identifier should be a GUID generated by the EFSP
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:RedactionIdentification
                                      Service Association Associates a Service Recipient on a Filing to a Service Provider. This is specific to Service of Process.
                                      • A reference to the recipient on the filing who is being served
                                      • The Code of the Service Provider where service for this association is being sent

                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:ServiceAssociation/tylercommon:ServiceReference
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:ServiceAssociation/tylercommon:ServiceProviderCode
                                      Due Date A due date associated to the filing, whereby the due date is some number of days after the filing, subject to court business processes. This field is only applicable if enabled via the following configuration:
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:DueDate/nc:DateTime
                                      Original Envelope ID The original rejected envelope number from which the current envelope was copied.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:OriginalEnvelopeID/nc:IdentificationID
                                      Parent Envelope This value only applies to a court's response (child envelope) to a proposed order (parent envelope). A proposed order can have no more than one child envelope.
                                      The envelope number to which this envelope relates.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:ParentEnvelope/tylercommon:EnvelopeID
                                      Attach Service Contact A boolean to indicate whether the service contacts being served should be attached to the case or specific case parties.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:AttachServiceContactIndicator
                                      Party Responsible for Fees The FilingParty structure indicates which case party is responsible for the fees associated with this filing.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:FilingParty/tylercommon:PartyReference
                                      Filing Attorney This identifies the attorney associated to this filing. If the FilingFilingAttorneyView data field configuration code is configured to be required, a firm user's filings must specify an AttorneyID in this field. This structure should contain empty values for Individual filers.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:FilingAttorney/tylercommon:AttorneyReference
                                      RemedyA valid ProcedureRemedy code
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:ProcedureRemedy/tylercommon:RemedyCode
                                      Damage AmountA valid DamageAmount code
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:ProcedureRemedy/tylercommon:DamageAmountCode
                                      Filer Type A valid FilerType code. This field is governed by the FilingFilerType data field configuration code
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:FilerTypeCode
                                      Cross Reference Number Consists of two fields which provide an alternate case number and a CrossReference code to identify the type of alternate case number being provided.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:CrossReference/tylercommon:ReferenceNumber
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:CrossReference/tylercommon:ReferenceTypeCode
                                      Maximum Fee Enables the filer to specify a maximum fee amount for an envelope submitted at that location. This governs filing adjustments made by the clerk during review. This element is dependent upon the AllowMaxFeeAmount field for the Court Location and is only available for envelopes that are filed with the clerk (and therefore go through clerk review).
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:MaxFeeAmount/nc:Amount
                                      Civil Claim Amount Amount of a claim that determines filing fees within the EFM and CMS. Used in select jurisdictions
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:CivilAmount/nc:Amount
                                      Probate Estate Amount Amount of a probate estate that determines filing fees within the EFM and CMS. Used in select jurisdictions
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:EstateAmount/nc:Amount
                                      Out of State Indicator Boolean flag to represent whether the filing includes out of state service
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:OutOfStateIndicator
                                      Return Date The return date for the filing. Only applicable at court locations where AllowReturnDate = True. Refer to the GetReturnDate API for more information.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:ReturnDate/nc:Date
                                      Batch Filing Batch filing is available in limited jurisdictions. Batch filing requires additional coordination between Tyler and the clerks
                                      • BatchID is a unique batch identifier to be provided by the EFSP. A GUID is recommended for this value, and may contain only alphabet (A-Z) characters, numbers (0-9), and the dash (-) character.
                                      • BatchName provides the title of the batch.
                                      • BatchSize is an integer representing the number of envelopes that will be submitted in the batch. This value should be constant for each envelope within the batch.
                                      • BatchSequence is an integer that represents the Nth envelope within the named batch. Must be a positive, non-zero integer that is unique within the batch and less than or equal to the batch size
                                      • BatchType os a batch code to identify the type of batch specified.
                                      • Group Identifier is for grouping of case participants
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Batch/tylercommon:BatchIdentification/nc:IdentificationID
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Batch/tylercommon:BatchName
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Batch/tylercommon:BatchSize
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Batch/tylercommon:BatchSequence
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Batch/tylercommon:BatchType
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:GroupIdentification/nc:IdentificationID
                                      Bulk Filing Bulk filing is available in limited jurisdictions.
                                      • BulkTitle provide a name for the bulk filing set
                                      • BulkSize provides the number of filings in the bulk filing set
                                      • BulkSubmissionID provides the sequence number of the current filing
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Bulk/tylercommon:BulkTitle
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Bulk/tylercommon:BulkSize
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:Bulk/tylercommon:BulkSubmissionID
                                      Envelope Comment A filer comment for the envelope This field is enabled/disabled per court location. Refer to Locations for relevant attribution.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/tylercommon:EnvelopeLevelComment
                                      Kiosk Filer Email The email of an anonymous Kiosk Filer in order to have them receive email notifications for their filing without having an account.
                                      /filing:FilingMessage/tylercommon:FilingMessageAugmentation/nc:DocumentSubmitter/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                      Court Location The court location identifier for the case
                                      /filing:FilingMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Attorney Attorneys can be either:
                                      • Case Party Attorneys - an instance record of an attorney representing a party on the case
                                      • Filing Attorneys - an attorney who is filing but is not representing a party on the case
                                      IdentificationID provides the EFM identifier for an attorney within the filer's firm. Refer to the Attorney Management APIs for more information.
                                      CaseRepresentedParty associates the attorney to the party being represented and can be repeated if representing multiple parties.

                                      The system can support multiple Case Party Attorney records for each CaseParty. This capability is enabled by default but can be disabled per court location. Refer to Locations for relevant attribution.

                                      One such Case Party Attorney is designated as the lead attorney via the IsLead element. If multiple Case Party Attorneys are specified for a Case Party, one and only one must be designated as the lead. A case party's lead attorney cannot be changed via e-filing. For backward compatibility, if there is only one Case Party Attorney for a given Case Party, the EFM will default that record to be the lead.
                                      /filing:FilingMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                      /filing:FilingMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/ecf:CaseOfficialAugmentation/ecf:CaseRepresentedParty
                                      /filing:FilingMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/tylercommon:CaseOfficialAugmentation/tylercommon:IsLead

                                      Case Category A valid CaseCategory code. Only applies to initial filings.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                      New Case Indicates whether the filing represents the filing of a new case
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseNewIndicator
                                      Case Party This structure defines a party that is associated to the case.

                                      A subsequent filing need not include a case party existing case parties. Rather, a case party is only necessary for a party that is being added to the case or if the participant is relevant to some aspect of the filing (e.g. to be designated as the filing party, or to be associated to the filing via FilingAssociation)
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty

                                      Person or Organization EntityPerson represents a case participant that is an individual. EntityOrganization represents a case participant that is an organization. The s:id attribute establishes an identifier whereby the case party can be referenced elsewhere within the message.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization
                                      PersonBirthDate Only valid for a person. This is a date value only. The value will be sent to the CMS but due to security implications it will not be available in subsequent interactions regarding the case
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonBirthDate/nc:Date
                                      Citizenship A valid Country Code to indicate the person's citizenship
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonCitizenshipISO3166Alpha2Code
                                      Ethnicity A valid NIEM ethnicity code
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonEthnicityText
                                      Eye Color A valid NIEM eye color code
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonEyeColorCode
                                      Hair Color A valid NIEM hair color code
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonHairColorCode
                                      Height A valid NIEM height measurement in inches
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonHeightMeasure
                                      Name The case party's name. PersonGivenName, PersonMiddleName, and PersonSurName are each limited to 100 characters but can be further restrained via the PartyFirstName, PartyMiddleName, and PartyLastName data field configuration codes. OrganizationName represents a case participant that is not a person (e.g. a business, an association). OrganizationName is limited to a maximum of 400 characters but can be further restrained via the PartyBusinessName data field configuration code.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonMiddleName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/nc:OrganizationName
                                      Physical Feature Describes a person's physical features. PhysicalFeatureDescriptionText provides a textual description of the physical feature PhysicalFeatureCategoryCode provides a valid NIEM physical feature code This element may be repeated as necessary to denote multiple features.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonPhysicalFeature/tylercommon:PhysicalFeatureCategoryCode
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonPhysicalFeature/tylercommon:PhysicalFeatureAugmentation/tylercommon:PhysicalFeatureDescriptionText
                                      Primary Language A valid NIEM language type code. This is used to determine if an interpreter is required
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonPrimaryLanguage/nc:LanguageCode
                                      Race A valid NIEM race code
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonRaceText
                                      Sex A valid NEIM person sex code
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonSexCode
                                      State ID The State ID assigned to this person
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonStateIdentification/nc:IdentificationID
                                      Person Weight Measure A valid NIEM person weight measurement in pounds
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonWeightMeasure/nc:MeasureDecimalValue
                                      FBI Number The FBI number assigned to this person
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/j:PersonAugmentation/j:PersonFBIIdentification/nc:IdentificationID
                                      Case Party Role A valid PartyType code to indicate the case party's role role within the case.
                                      Self Represented A boolean to indicate whether this is a self-represented litigant
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:CasePartySelfRepresentationIndicator
                                      Add Me As Service Contact Indicator A boolean to indicate whether the filler wants to be added as a service contact on this party.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tyler:PersonAugmentation/tyler:AddMeAsServiceContactIndicator
                                      Service Consent Email If a case participant consents to eService, an email is required in the Contact Information.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/tyler:ServiceConsentEmail
                                      Case Party Address Mailing address for the case participant. The address is optional; however, partial addresses are not allowed. If any information is provided then street, city, state, country, and zip are all required. For example, you cannot provide a state name without providing street information, zip code, and country. Only one address is allowed per party.
                                      Address Line 2 Line 2 of the address
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine
                                      Street Address The street portion of the address
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                      City The city portion of the address
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                      State The state portion of the address If the EFM has no state codes configured for the selected country, a value for the state field must still be provided but will be ignored by the EFM. Therefore you can simply pass the country code value in as the state code.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                      Country The country code of the address
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                      Zip The zip code portion of the address
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                      Person Identifier A court established unique identifier for a person or organization. The valid values are set outside of e-filing
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:FilerIdentification/nc:IdentificationID
                                      Date of Death Indicates the date of dath of the case party. Used only if the party type is configured to allow or require the party date of death
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/nc:PersonDeathDate
                                      I Am This User Boolean to indicate that this case party is the person submitting the filing. This indicator cannot be set true for filers who belong to a firm. This indicator cannot be set true for case parties who are of type EntityOrganization.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:IAmThisUserIndicator
                                      Alias Reserved for Tax Delinquency cases. Consists of two fields which provide the ability to associate aliases for case participants. The structure may be repeated as necessary to reflect one or more aliases for each case participant. This data is not incorporated into Odyssey File & Serve nor Odyssey Case Manager - it is merely passed to the 3rd party Clerk CMS. The values are free text.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:Alias/tylercommon:AliasName
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:Alias/tylercommon:AliasTypeCode
                                      CaseID Provides a unique EFM identifier for an existing case. This identifier is returned by the GetCaseList API.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                      Case TypeA valid CaseType code
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                      Amount In Controversy The ad damnum value. Only applicable if the filing code is configured AmountInControversy=Required. When enabled this value affects the calculations for fees and return date
                                      /filing:FilingMessage/nc:Case/civil:CaseAugmentation/civil:AmountInControversy/nc:Amount
                                      Case Sub Type A valid Case Sub Type code if the case type allows for a case sub type.
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseSubTypeCode
                                      Person Associations Reserved for Tax Delinquency cases, the PersonAssociation structure provides the ability to relate case participants together. The structure may be repeated as necessary to reflect one or more such associations. This data is not incorporated into Odyssey File & Serve nor Odyssey Case Manager - it is merely passed to the 3rd party Clerk CMS. The values are free text.
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/nc:PersonAssociation/nc:Person
                                      Case Abstractor & Fees Reserved for Tax Delinquency cases, the CaseAbstractor structure provides the ability to the name of an abstractor and associated fees. The structure may be repeated as necessary to reflect one or more aliases for each case participant. This data is not incorporated into Odyssey File & Serve nor Odyssey Case Manager - it is merely passed to the 3rd party Clerk CMS. The values are free text.
                                      /filing:FilingMessage/nc:Case/tylertax:CaseAugmentation/tylertax:CaseAbstractor/tylertax:Abstractor/nc:EntityOrganization/nc:OrganizationName
                                      /filing:FilingMessage/nc:Case/tylertax:CaseAugmentation/tylertax:CaseAbstractor/tylertax:Fees/nc:Amount
                                      Tax Service of Party Reserved for Tax Delinquency cases, the PartyService structure provides the ability to specify a service type and delivery method. The structure may be repeated as necessary to reflect this information for each case participant. This data is not incorporated into Odyssey File & Serve nor Odyssey Case Manager - it is merely passed to the 3rd party Clerk CMS. The values are free text.
                                      /filing:FilingMessage/nc:Case/tylertax:CaseAugmentation/tylertax:PartyService/tylercommon:PartyReference
                                      /filing:FilingMessage/nc:Case/tylertax:CaseAugmentation/tylertax:PartyService/tylertax:ServiceTypeCode
                                      /filing:FilingMessage/nc:Case/tylertax:CaseAugmentation/tylertax:PartyService/tylertax:DeliveryMethodCode
                                      Property Account Number Reserved for Tax Delinquency cases, the PropertyAccountNumber structure provides the ability to pass account numbers to the court. The structure may be repeated as necessary to reflect one or more account numbers for the case. This data is not incorporated into Odyssey File & Serve nor Odyssey Case Manager - it is merely passed to the 3rd party Clerk CMS. The values are free text.
                                      /filing:FilingMessage/nc:Case/tylertax:CaseAugmentation/tylertax:PropertyAccountNumber
                                      Will Filed Date The date for the filing of the will.
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:WillFiledDate
                                      Parent Case Information about the parent case for which this envelope's case is a child of
                                      • The EFM's unique identifier for the related case
                                      • The type of relation between this case and the related case

                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:ParentCase/ecf:CaseTrackingID/nc:IdentificationID
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:ParentCase/tylercommon:CaseRelationType
                                      Notification Agency The Code for the Notification Agency associated with this Case
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:AgencyCode
                                      Case Address Physical address associated with the case. The address is configurable by the case type to be required, optional, or not supported. Note that partial addresses are not allowed. If any information is provided, then street, city, state, county, and zip are all required. For example, you cannot provide a state name without providing street information, zip code, and county. Values are free text except for the state codes. US is the only country code supported. Only one address is allowed per case.
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseAddress/nc:LocationStreet/nc:StreetFullText
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseAddress/nc:LocationCityName
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseAddress/nc:LocationState/nc:LocationStateName
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseAddress/nc:LocationCountry/nc:LocationCountryName
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseAddress/nc:LocationPostalCode
                                      Driver License Consists of three fields which provide a person driver license. IdentificationID should contain the person's driver license number. DriverLicenseTypeCode should contain a valid Driver License Type code . LocationStateName should contain a valid State code . The values will be sent to the CMS but due to security implications they will not be available in subsequent interactions regarding the case
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:DriverLicenseIdentification/nc:IdentificationID
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:DriverLicenseIdentification/tylercommon:DriverLicenseTypeCode
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:DriverLicenseIdentification/nc:LocationStateName
                                      SSN The Social Security Number as provided by the filer. The value will be sent to the CMS but due to security implications it will not be available in subsequent e-Filing interactions regarding the case
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:SSNIdentification/nc:IdentificationID
                                      Email Email address for the case participant
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                      Phone Number Telephone number for the case participant
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactTelephoneNumber/nc:FullTelephoneNumber/nc:TelephoneNumberFullID
                                      Case Party ID The unique EFM identifier for an existing case party.
                                      This is only applicable for subsequent filings, when referencing an existing party on the case
                                      /filing:FilingMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                      Tracking Number A filer provided tracking number
                                      /filing:FilingMessage/filing:FilingLeadDocument/tylercommon:DocumentAugmentation/tylercommon:FilerReferenceNumber
                                      Question & Answer This structure allows a configured question code and corresponding answer code pertaining to the filing. The element may be repeated with unique question codes.
                                      /filing:FilingMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:QuestionAnswer
                                      Ad Hoc Hearing Information This structure contains four element which correspond to each of the Ad Hoc Hearing flags. They may be optional depending on the configuration for the motion type code being used on the Lead Filing.
                                      /filing:FilingMessage/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingDate
                                      /filing:FilingMessage/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingTime
                                      /filing:FilingMessage/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingLocation
                                      /filing:FilingMessage/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingJudge
                                      EFSP Fees Boolean to indicate whether the EFSP is requesting the EFM to collect an EFSP fee and associated tax.
                                      NOTE: EFSP fees cannot be collected when a waiver payment account is being used.
                                      /payment:PaymentMessage/cac:AllowanceCharge/cbc:ChargeIndicator
                                      Amount The amount to collect for the EFSP fee
                                      /payment:PaymentMessage/cac:AllowanceCharge/cbc:Amount
                                      Percent The tax rate used to calculate the tax amount
                                      /payment:PaymentMessage/cac:AllowanceCharge/cac:TaxCategory/cbc:Percent
                                      Tax Amount The amount of tax to collect
                                      /payment:PaymentMessage/cac:AllowanceCharge/cac:TaxTotal/cbc:TaxAmount
                                      Payment ID The unique EFM identifier of a valid payment account. The payment account must either belong to the user's firm, or it must be a global payment account that belongs to the EFSP calling this API.
                                      /payment:PaymentMessage/cac:AllowanceCharge/cac:PaymentMeans/cbc:PaymentID
                                      Outputs
                                      FieldDescription
                                      Error In all TEST EFM environments certain dollar amounts will trigger errors within the Chase Paymentech TEST system. Payment processing consists of two credit card/bank account transactions: a primary transaction for monies due to the court and a secondary transaction for any other monies due. While either the primary or secondary amount can technically trigger the errors, in practice only the primary amount is large enough to do so. Trigger amounts are provided in the following spreadsheet: Chase Test System - Trigger Amounts.xlsx
                                      EFM Identifiers The DocumentIdentification structure is repeated as necessary to return the EFM's unique identifiers appropriate for the filing that was submitted. The IdentificationID element provides the unique EFM identifier and the IdentificationCategoryDescriptionText provides the type of identifier.
                                      • CaseID - An identifier for the case. Only applicable for initial filings
                                      • EnvelopeID - A unique integer based envelope number assigned by the EFM. This envelope number should be provided to the filer as it provides a means of identifying their submission. This identifier is also visible to the clerk reviewers.
                                      • FilingID - Repeated for each filing in the envelope, in the order received.

                                      /cbrn:MessageStatus/ecf:MessageStatusAugmentation/nc:DocumentIdentification/nc:IdentificationID
                                      /cbrn:MessageStatus/ecf:MessageStatusAugmentation/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                      DocumentReceivedDate UTC Date/Time stamp of when the envelope was received by the EFM.
                                      /cbrn:MessageStatus/cbrn:SystemEventDateTime
                                      BulkID If the envelope is part of a Bulk Filing, a BulkID is returned.
                                      /cbrn:MessageStatus/ecf:MessageStatusAugmentation
                                      BlackoutStatus When a court location is in a blackout, the following will be returned:
                                      • ReasonDescriptionText - the reason entered for the blackout
                                      • BlackoutDate - the Start and End dates

                                      /cbrn:MessageStatus/tylercommon:MessageStatusAugmentation



                                      ReviewFiling: Appellate Case Augmentation

                                      This section outlines the items within the Appellate Case Augmentation for case initiation. Please refer to the                                       ReviewFiling API for additional information that pertains to the use of ReviewFiling in general.
                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelopes resource.
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfiling
                                      appellate
                                      Response Message Definitioncbrn
                                      XML Samples
                                      DescriptionRequestResponse
                                      Filing Message for Appellate Case Initiationtyler-initial-appellate-filingmessageN/A
                                      Inputs
                                      FieldDescription
                                      Lower Court Case Title The case style/title of the case in the lower court. Subject to constraints set via CaseInformationLowerCourtCaseStyle Data Field Configuration Code. Otherwise a maximum length of 5000 characters
                                      /filing:FilingMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/nc:CaseTitleText
                                      Lower Court Case Number The case number of the case in the lower court. Subject to constraints set via CaseInformationLowerCourtCaseNumber Data Field Configuration Code. Otherwise a maximum length of 30 characters
                                      /filing:FilingMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:CaseAugmentation/j:CaseLineageCase/ecf:CaseAugmentation/j:CaseNumberText
                                      Lower Court Name The court name of the case in the lower court. Subject to constraints set via CaseInformationLowerCourtName Data Field Configuration Code. Otherwise a maximum length of 30 characters
                                      /filing:FilingMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:CaseAugmentation/j:CaseCourt/nc:OrganizationName
                                      Lower Court Judge Name The judge name of the case in the lower court. Subject to constraints set via CaseInformationLowerCourtCaseJudge Data Field Configuration Code. Otherwise a maximum length of 150 characters.
                                      /filing:FilingMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                      Lower Court Case Category The Case Category code of the case in the lower court.
                                      /filing:FilingMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                      Lower Court Case Type The Case Type code of the case in the lower court.
                                      /filing:FilingMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/ecf:CaseAugmentation/ecf:CaseTypeCode
                                      Outputs
                                      FieldDescription
                                      No Outputs



                                      ReviewFiling: Criminal Case Augmentation

                                      This section outlines the items within the Criminal Case Augmentation for case initiation. While any of the elements below may be used for a 3rd party CMS, some fields are valid only for specifically configured court locations. Please refer to the                                       ReviewFiling API for additional information that pertains to the use of ReviewFiling in general.

                                      For criminal case initiations note that the EFM requires one and only one defendant party type and at least one offense charged to that defendant. The offense requires:

                                      • Statute code
                                      • Charge description
                                      • Degree
                                      • Offense date or date range

                                      IMPORTANT: The CMS may have additional requirements for initiating criminal cases, either generally or specifically for your jurisdiction's unique requirements.

                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToLimited to governmental agencies, granted by Tyler
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfiling
                                      criminal
                                      payment
                                      common
                                      Response Message Definitioncbrn
                                      XML Samples
                                      DescriptionRequestResponse
                                      Filing - Initial Filing for Criminaltyler-initial-criminal-filingmessageN/A
                                      Inputs
                                      FieldDescription
                                      Arrest Date The date of the arrest
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/nc:ActivityDate/nc:DateTime
                                      Arrest Number The arrest number
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestAgencyRecordIdentification/nc:IdentificationID
                                      Charge This is a container for the charge information and it will repeat if more than one charge
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge
                                      Charge Sequence Number The charge sequence number
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/j:ChargeSequenceID
                                      Offense Code A valid Degree code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/j:ChargeStatute/j:StatuteCodeIdentification/nc:IdentificationID
                                      Statute Description A textual description of the statute. For example "Abuse of Official Capacity"
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/j:ChargeStatute/j:StatuteDescriptionText
                                      Degree A valid Degree code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/j:ChargeStatute/j:StatuteLevelText
                                      Statute The statute, per the penal code. For example "39.02"
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/j:ChargeStatute/j:StatuteOffenseIdentification/nc:IdentificationID
                                      General Offense Code A General Offense code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/j:ChargeStatute/tylercriminal:StatuteAugmentation/tylercriminal:GeneralOffenseCode
                                      Charge Tracking Number The arrest charge tracking number
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:TrackingNumber
                                      Offense Date This may be a date, a date range, and may include "on or about" indicators for the date and time
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:OffenseDate/nc:Date
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:OffenseDate/nc:DateTime
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:OffenseDate/nc:DateRange
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:DateOnOrAboutIndicator
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:TimeOnOrAboutIndicator
                                      Bond Type A valid Bond code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:Bond/tylercriminal:BondTypeCode
                                      Bond Amount The bond amount
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:Bond/tylercriminal:BondAmount/nc:Amount
                                      Charge Phase A valid optional Charge Phase code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:PhaseTypeCode
                                      Addtitional Statute A collection of data elements pertaining to an additional statute This is necessary in states where the penal code is organized in such a way that the prosecutor must reference an additional statute in order to further identify the charge. As an example, the additional statue may define a modifier, like "attempt". Or as another example, the additional statute may define a penalty range based on the offense's circumstances. The system supports multiple additional statutes.
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute
                                      General Offense Code A valid GeneralOffense code for the additional statute
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute/tylercriminal:StatuteAugmentation/tylercriminal:GeneralOffenseCode
                                      Statute Type A valid StatuteType code for the additional statute
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute/tylercriminal:StatuteAugmentation/tylercriminal:StatuteTypeCode
                                      Offense Code A valid Statute code for the additional statute
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute/j:StatuteCodeIdentification/nc:IdentificationID
                                      Statute Description A textual description of the statute. For example "Abuse of Official Capacity"
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute/j:StatuteDescriptionText
                                      Degree A valid Degree code for the additional statute
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute/j:StatuteLevelText
                                      Statute The statute, per the penal code. For example "39.02"
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestCharge/tylercriminal:ChargeAugmentation/tylercriminal:AdditionalStatute/j:StatuteOffenseIdentification/nc:IdentificationID
                                      Arrest Location A valid ArrestLocation code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestLocation/nc:LocationName
                                      Badge Number The badge number of the arresting officer
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestOfficial/j:EnforcementOfficialBadgeIdentification/nc:IdentificationID
                                      Law Enforcement Unit A valid LawEnforcementUnit code
                                      /filing:FilingMessage/nc:Case/criminal:CaseAugmentation/j:Arrest/j:ArrestOfficial/j:EnforcementOfficialUnit/nc:OrganizationIdentification/nc:IdentificationID
                                      Outputs
                                      FieldDescription
                                      No Outputs



                                      ReviewFiling: Citation Case Augmentation

                                      This section outlines the items within the Citation Case Augmentation for case initiation. While any of the elements below may be used for a 3rd party CMS, some fields are valid only for specifically configured court locations. Please refer to the                                       ReviewFiling API for additional information that pertains to the use of ReviewFiling in general.

                                      For criminal case initiations note that the EFM requires one and only one defendant party type and at least one offense charged to that defendant. The offense requires:

                                      • Statute code
                                      • Charge description
                                      • Degree
                                      • Offense date or date range

                                      IMPORTANT: The CMS may have additional requirements for initiating criminal cases, either generally or specifically for your jurisdiction's unique requirements.

                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToLimited to governmental agencies, granted by Tyler
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfiling
                                      citation
                                      payment
                                      common
                                      Response Message Definitioncbrn
                                      XML Samples
                                      DescriptionRequestResponse
                                      Filing - Initial Filing for Criminaltyler-initial-criminal-citation-filingmessageN/A
                                      Inputs
                                      FieldDescription
                                      Citation The container for the citation information. Repeat to represent multiple citations
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation
                                      Citation # The citation number. This number is required if the citation container is included in the message.
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:Citation/nc:ActivityIdentification/nc:IdentificationID
                                      Jurisdiction A valid Citation Jurisdiction Code for the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:Citation/nc:ActivityIdentification/nc:IdentificationJurisdiction/nc:JurisdictionText
                                      Date/Time Date of the creation of the citation. This date is required if the citation container is included in the message.
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:Citation/nc:ActivityDate/nc:DateTime
                                      Location Description The description of the location of the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:Citation/nc:ActivityDescriptionText
                                      Violated Statute The element value itself is not used, however the reference associates the citation to a charge. This reference is required if the citation container is included in the message.
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:IncidentViolatedStatuteAssociation
                                      Appear By Date/Time The Appear By date and time on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:CourtAppearance/j:CourtAppearanceDate/nc:DateTime
                                      Issued To Reference to the party being issued the citation. This reference is required if the citation container is included in the message.
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:Citation/j:CitationSubject/nc:RoleOfPerson
                                      Vehicle/Party Association Party to which the vehicle on the citation is associated
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleAugmentation/tylercommon:PartyReference
                                      Vehicle The container for vehicle information on the citation
                                      filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle
                                      Registration Number The license plate number of the vehicle on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleAugmentation/tylercommon:RegistrationNumber
                                      Registration State The license plate State code of the vehicle on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleAugmentation/tylercommon:RegistrationStateName
                                      Vehicle Type A valid Vehicle Type Code vehicle type code for the vehicle on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleAugmentation/tylercommon:VehicleTypeCode
                                      Model Year The year of the vehicle on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/nc:ItemModelYearDate
                                      Vehicle Make A valid Vehicle Make Code vehicle make code for the vehicle on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleMakeCode
                                      Vehicle Color A valid Vehicle Color Code vehicle color code for the vehicle on the citation
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/nc:ConveyanceColorPrimaryText
                                      Commercial Vehicle Boolean indicating if the vehicle on the citation is a commercial vehicle
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleAugmentation/tylercommon:CommercialVehicleIndicator
                                      Hazardous Materials Boolean indicating if the vehicle on the citation is a hazardous material vehicle
                                      filing:FilingMessage/nc:Case/citation:CaseAugmentation/nc:Vehicle/tylercommon:VehicleAugmentation/tylercommon:HazardousLoadIndicator
                                      Posted Speed Limit The posted speed limit.
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:DrivingIncident/j:DrivingIncidentLegalSpeedRateMeasure/nc:MeasureDecimalValue
                                      Actual Speed The measured speed of the vehicle.
                                      /filing:FilingMessage/nc:Case/citation:CaseAugmentation/j:DrivingIncident/j:DrivingIncidentRecordedSpeedRateMeasure/nc:MeasureDecimalValue
                                      Outputs
                                      FieldDescription
                                      No Outputs



                                      GetFilingList

                                      GetFilingList retrieves a list of filings matching several criteria including the filer identifier and filed date within a certain time range. If a filer identifier is not passed in then the results will include filings submitted by any user in the firm.

                                      The intent for this call is to retrieve a subset of filings, not a complete historical record of all filings for the specified criteria; therefore the EFM imposes an upper bound of 1000 results. The most recent filings by filed date are returned. Selection and results list sort by descending date filed (reverse chronological order).

                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToAny registered user. If CSM is enabled, requires the FilingHistory resource.
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfilinglistrequest
                                      Response Message Definitionfilinglistresponse
                                      XML Samples
                                      DescriptionRequestResponse
                                      GetFilingListtyler-filinglistrequesttyler-filinglistresponse
                                      Inputs
                                      FieldDescription
                                      Court Location If populated, results will only include filings for the specified court location. If not populated, results will include filings for all court locations
                                      /filinglistrequest:GetFilingListRequestMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Filing Status If populated, results will only include filings in the specified status.
                                      /filinglistrequest:GetFilingListRequestMessage/filinglistrequest:FilingListQueryCriteria/tylercommon:FilingListQueryCriteriaAugmentation/ecf:FilingStatus/ecf:FilingReviewStatusCode
                                      Case Number If populated, results will only include filings that match the case number
                                      /filinglistrequest:GetFilingListRequestMessage/filinglistrequest:FilingListQueryCriteria/j:CaseNumberText
                                      Date Range If StartDate and EndDate are populated, results will only include filings created within the designated date range
                                      /filinglistrequest:GetFilingListRequestMessage/filinglistrequest:FilingListQueryCriteria/nc:DateRange/nc:StartDate/nc:Date
                                      /filinglistrequest:GetFilingListRequestMessage/filinglistrequest:FilingListQueryCriteria/nc:DateRange/nc:EndDate/nc:Date
                                      Envelope Number If populated, results will only include filings that match the envelope number
                                      /filinglistrequest:GetFilingListRequestMessage/filinglistrequest:FilingListQueryCriteria/nc:DocumentIdentification/nc:IdentificationID
                                      Submitter If populated with an EFM UserId (obtained from GetUserList) results will only include filings for the specified user. If not populated, results will include filings for any users in the firm
                                      /filinglistrequest:GetFilingListRequestMessage/filinglistrequest:FilingListQueryCriteria/nc:DocumentSubmitter/nc:EntityPerson/nc:PersonOtherIdentification/nc:IdentificationID
                                      Outputs
                                      FieldDescription
                                      EFSP Filing Source The Name of the EFSP Filing Source where this Filing was filed
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/common:MatchingFilingAugmentation/common:FilingProvider/nc:OrganizationName
                                      Filed Date/Time The date/time the filing was filed
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:DocumentFiledDate/nc:DateTime
                                      Envelope Number and Filing ID IdentificationID and IdentificationCategoryDescriptionText pairs that contain envelope numbers and unique filing identifiers
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:DocumentIdentification/nc:IdentificationID
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                      Submitted by Name Name of the submitter
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:DocumentAugmentation/ecf:DocumentFiler/nc:EntityPerson/nc:PersonName/nc:PersonFullName
                                      Submitted UserID UserId of the submitter
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:DocumentAugmentation/ecf:DocumentFiler/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                      Court Location The location of the filing
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Submit Date/Time The date/timestamp the filing was submitted
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:DocumentPostDate/nc:DateTime
                                      FilingStatus The status of the filing
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/ecf:FilingReviewStatusCode
                                      Filing Description The filing description as provided by the filer
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentTitleText
                                      Filing Code The filing code for the filing
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
                                      Filing Type Indicates the type of filing, as follows:
                                      • EFile
                                      • EFileAndServe
                                      • Serve

                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:FilingAction
                                      DocumentFileControlID The filing reference number as provided by the filer
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:FilerReferenceNumber
                                      DeferredUntilDate Provides the date to which the clerk has deferred review of the filing
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/common:DocumentAugmentation/common:DeferredUntilDate/nc:DateTime
                                      Case Title The case title/description/style/caption for the associated case
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/nc:CaseTitleText
                                      Filing Attorney The name of the attorney on record as the filing attorney for the filing
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                      Case Category Code The category code for the case
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                      CaseTrackingID Unique EFM identifier for the associated case
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                      Case Type Code The case type code for the case
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                      Case Number The court case number for the associated case
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                      Case Judge The judge presiding over the case
                                      /filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                      Grace Period Expiration Date Alloted time/date for an envelope to allow the filer to retain their original docket date if they resubmit within the grace period
                                      //filinglistresponse:GetFilingListResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/common:FilingStatusAugmentation/common:GracePeriodExpirationDate



                                      GetFilingStatus

                                      GetFilingStatus retrieves the status of a filing.

                                      NOTE: This API should not be used as an automated polling mechanism in lieu of implementing NotifyFilingReviewComplete

                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToAny registered user. If CSM is enabled, requires the FilingHistory resource.
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitionfilingstatusrequest
                                      Response Message Definitionfilingstatusresponse
                                      XML Samples
                                      DescriptionRequestResponse
                                      GetFilingStatustyler-filingstatusrequesttyler-filingstatusresponse
                                      GetFilingStatus - Detailstyler-detail-filingstatusrequesttyler-detail-filingstatusresponse
                                      GetFilingStatus - Acceptedtyler-detail-filingstatusrequesttyler-detail-filingstatusresponse-accepted
                                      GetFilingStatus - Rejectedtyler-detail-filingstatusrequesttyler-detail-filingstatusresponse-rejected
                                      GetFilingStatus - MPRFFtyler-detail-filingstatusrequesttyler-detail-filingstatusresponse-mprff
                                      GetFilingStatus - Merged Documenttyler-detail-filingstatusrequesttyler-detail-filingstatusresponse-mergedDocument
                                      GetFilingStatus - Ad Hoc Hearingtyler-detail-filingstatusrequesttyler-detail-filingstatusresponse-adhoc-hearing
                                      GetFilingStatus - Service of Processtyler-detail-filingstatusrequesttyler-detail-filingstatusresponse-serviceofprocess
                                      Inputs
                                      FieldDescription
                                      Court Location The Court Locations code for this document Must be a valid court location identifier; however, the actual value provided does not affect the results of the API
                                      /filingstatusrequest:GetFilingStatusRequestMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Filing ID The EFM's unique identifier for the desired filing
                                      /filingstatusrequest:GetFilingStatusRequestMessage/filingstatusrequest:FilingStatusQueryCriteria/nc:DocumentIdentification/nc:IdentificationID
                                      Include Details Boolean to request addtional details
                                      /filingstatusrequest:GetFilingStatusRequestMessage/tylercommon:GetFilingStatusRequestMessageAugmentation/tylercommon:IncludeFilingDetailIndicator
                                      Outputs
                                      FieldDescription
                                      Original Envelope The envelope number of the original envelope from which this envelope was copied
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:OriginalEnvelopeID/nc:IdentificationID
                                      Parent Envelope The envelope number of the parent envelope for a proposed order
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ParentEnvelope/tylercommon:EnvelopeID
                                      Parent Filings The EFM's unique identifier for the parent filings for a proposed order
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ParentEnvelope/tylercommon:FilingID
                                      Child Envelope(s) A child envelope number for this order. Multiple child envelopes may exist therefore the Child structure will repeat as necessary
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ChildEnvelope/tylercommon:Child/tylercommon:EnvelopeID
                                      Child Filing(s) The EFM's unique identifier for the child filing for this order. Will repeat as necessary
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ChildEnvelope/tylercommon:Child/tylercommon:FilingID
                                      Remedy A ProcedureRemedy code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ProcedureRemedy/tylercommon:RemedyCode
                                      Damage Amount A DamageAmount code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ProcedureRemedy/tylercommon:DamageAmountCode
                                      Filer Type A filer type code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:FilerTypeCode
                                      Cross Reference Number A case cross reference number
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:CrossReference/tylercommon:ReferenceNumber
                                      Cross Reference Type A case cross reference type code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:CrossReference/tylercommon:ReferenceTypeCode
                                      Return Date The return date
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ReturnDate/nc:Date
                                      Envelope Comment The filer's envelope comment
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:EnvelopeLevelComment
                                      Account Name The name of the payment account used for paying the filing costs
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:AccountName
                                      Waiver Indicates whether a waiver was used for this filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:WaiverIndicator
                                      Card Type The card type that was used for payment. Will be empty if not paid by credit card.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:CardType
                                      Last4 The last 4 digits of the card used for payment. Will be a value of zero if not paid by credit card.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:CardLast4
                                      Expiration Month The expiration month for the card. Will be a value of zero if not paid by credit card.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:ExpirationMonth
                                      Expiration Year The expiration month for the card. Will be a value of zero if not paid by credit card.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:ExpirationYear
                                      Amount The total amount of the payment
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:TransactionAmount/nc:Amount
                                      Transaction ID The transaction ID for the payment
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:TransactionID
                                      Order ID A unique transaction number that is passed to the payment processing system for inclusion on the account holder statement. The OrderID is derived from the envelope number. For batch filing (available in limited jurisdictions), the OrderID is derived from the BatchID provided by the EFSP.
                                      //filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:Payment/tylercommon:OrderID
                                      Service Contact ID The EFM's unique identifier for the service contact
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:ServiceContactID/nc:IdentificationID
                                      Service Contact Service Type The EFM's code for the Service Type on this Service
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:ServiceContactID/tylercommon:ServiceTypeCode
                                      Service Status Indicates the status of service for this recipient, values are Sent, Not Sent, or Error
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:Status
                                      Service Contact Information Provides the name and email address for a service contact.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/tylercommon:AdministrativeCopyEmailID
                                      Service Contact Mailing Address Information Provides the mail address details for a service contact.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:RecipientPerson/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                      Firm Name The name of the firm to which the service contact belongs
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:FirmName
                                      Served Indicates when service was sent
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:ServedDate/nc:DateTime
                                      Opened Indicates whether the service document was opened
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:ServiceOpenedIndicator
                                      Mail Service Indicator Indicates that this service contact is a mail service contact and will not receive eService.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:MailServiceIndicator
                                      Open Date The Date/Time the service document was opened
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:OpenedDate/nc:DateTime
                                      Mail Service Boolean to indicate that service is via postal mail. If the value is true, the address will be included in the ServiceRecipientDetail element
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:ServiceRecipient/tylercommon:MailServiceIndicator
                                      Envelope Fees The fees associated to the envelope
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:EnvelopeFee
                                      Filing Fees The fees associated to the envelope
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:FilingFee
                                      Service of Process Fees The fees associated with Service of Process Envelope Fees includes the Total Process Server Base Fees and Total Process Server Supplemental Fees for the Envelope, while Filing Fees includes only the Process Server Base Fee and Process Server Supplemental Fee for the specific filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:EnvelopeFee
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:FilingFee
                                      Filing Attorney The filing attorney
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:FilingAttorney/tylercommon:AttorneyReference
                                      Party The party responsible for fees
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:FilingParty/tylercommon:PartyReference
                                      Max Fee The filer's indicated max fee amount for the envelope
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:MaxFeeAmount/nc:Amount
                                      RefundVoidCharge Repeats for any refund/void transactions that exist for the envelope, to provide the data, amount, refund reason code, and a comment.

                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:RefundVoidCharge
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:RefundVoidCharge/tylercommon:RefundDate/nc:Date
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:RefundVoidCharge/tylercommon:Amount/nc:Amount
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:RefundVoidCharge/tylercommon:ReasonCodeID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/tylercommon:MatchingFilingAugmentation/tylercommon:RefundVoidCharge/tylercommon:Comment
                                      Envelope Number IdentificationID will contain the envelope number when IdentificationCategoryDescriptionText="envelopeID"
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentIdentification/nc:IdentificationID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                      EFM Filing Identifier IdentificationID will contain the filing identifier when IdentificationCategoryDescriptionText="filingID"
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentIdentification/nc:IdentificationID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                      Full name The full name of the person who submitted the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentSubmitter/nc:EntityPerson/nc:PersonName/nc:PersonFullName
                                      Email The email address of the person who submitted the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentSubmitter/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                      Email The email address of the person who submitted the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentSubmitter/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                      Firm Name The firm name to which the submitter belongs
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentSubmitter/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:FirmName
                                      Court Location The Court Locations code where the filing was filed
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Submitted Date/time the filing was submitted
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:DocumentPostDate/nc:DateTime
                                      Document A document attachment
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                      Filing Component The Filing Component code for this document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                      Page Count The page count for the document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                      Original Filename The original filename of the document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                      Redacted Indicates whether the document is redacted
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                      Document description The filer's description of the document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                      URL The URL where the document may be downloaded
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                      File Size The size of the document in bytes
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                      Document Type The Document Type code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                      Parent Document A reference to the associated lead document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/nc:DocumentAssociation/nc:PrimaryDocument
                                      Docket Date/Time The date/time the court docketed the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:DocketDate/nc:DateTime
                                      Accept Date/Time The date/time the filing was accepted
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:AcceptDate/nc:DateTime
                                      Review Comments The reviewer's comments at time of acceptance or rejection, if any
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:ReviewCommentsText
                                      Rejection Reason A rejection reason code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:RejectReasonCode
                                      Status Provides the Filing Status code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/ecf:FilingReviewStatusCode
                                      Filing A container for the details of the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview
                                      Filing Description The filer's description of the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentDescriptionText
                                      Document A container for the details of the primary document for this filing. Includes an id attribute for potential reference elsewhere within the message
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/@structures:id
                                      Filing Component The Filing Component code for this document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                      Page Count The page count for the document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                      Original Filename The original filename of the document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                      Redacted Indicates whether the document is redacted
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                      Document description The filer's description of the document
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                      URL The URL where the document may be downloaded
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                      File Size The size of the document in bytes
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                      Document Type The Document Type code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                      Filing Code The Filing code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
                                      Optional Service IdentificationID must contain a valid OptionalServices code

                                      MultiplierAmount provides a fee multiplier for the optional service. A value must be provided if the optional services code is configured to require a multiplier. Refer to Optional Services Codes for more details.

                                      Amount contains a filer provided fee amount. A value must be provided if the optional services code is configured to use a fee prompt. Refer to Optional Services Codes for more details.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/nc:IdentificationID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tylercommon:MultiplierAmount
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/nc:Amount

                                      If using a configured Optional Service code, multiple parties may be responsible for fees (MPRFF) in which Party Payor will contain their PartyReference, WaiverIndicator, and PaymentAccountID.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tylercommon:PartyPayor/nc:IdentificationID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tylercommon:PartyPayor/nc:WaiverIndicator
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DocumentOptionalService/tylercommon:PartyPayor/nc:PaymentAccountID

                                      Party to Filing Association Represents an association between a party and the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:FilingAssociation/tylercommon:PartyReference
                                      Filer Comments The filer's comments about the filing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:FilingCommentsText
                                      CourtesyCopiesText A comma separate list of email addresses that were to receive courtesy copies
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:CourtesyCopiesText
                                      PreliminaryCopiesText A comma separate list of email addresses that were to receive preliminary copies
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:PreliminaryCopiesText
                                      DeferredUntilDate The date until which this filing was deferred
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:DeferredUntilDate/nc:DateTime
                                      Motion Type The Motion Type code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:LeadDocumentReview/ecf:ReviewedDocument/tylercommon:DocumentAugmentation/tylercommon:MotionTypeCode
                                      Case Title The case title
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/nc:CaseTitleText
                                      Court Location The Court Locations code where the filing was filed
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Hearing Start The scheduled start date/time of the hearing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtSchedule/tylercommon:ScheduleDayStartTime/nc:DateTime
                                      Hearing End The scheduled end date/time of the hearing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtSchedule/tylercommon:ScheduleDayEndTime/nc:DateTime
                                      Courtroom The courtroom for the hearing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtRoom
                                      Court Street Address The physical address for the hearing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtStreet
                                      Court CSZ The city, state, zip of the court
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtCityStateZip
                                      Judge They judge for the case
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                      Attorney Name The filing attorney
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/nc:PersonName
                                      Attorney ID The EFM's unique identifier for the filing attorney
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                      Represents A reference to the case party this attorney is representing
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/j:CaseAugmentation/j:CaseOfficial/ecf:CaseOfficialAugmentation/ecf:CaseRepresentedParty
                                      Case Category The Case Category code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                      Case Party Repeated for any case party that is relevant to the filing.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson
                                      Case Party Identifier The EFM's unique identifier for the case party
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                      EFM Case ID The EFM's unique identifier for the case
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                      Case Type Code The Case Type code
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                      Court Case Number The court case number
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                      Grace Period Expiration Date Alloted time/date for an envelope to allow the filer to retain their original docket date if they resubmit within the grace period
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:GracePeriodExpirationDate
                                      PartialWaiver Provides details in regard to a standing waiver, if the filer has an active waiver on the case
                                      • ParentEnvelopeID - Identifies the envelope whereby the filer requested the waiver. Present only on filings that were submitted while the filer had an active waiver on the case
                                      • Outstanding balance - any remaining balance due from a filing whereby a standing waiver was requested
                                      • Court decision - GRANT if a waiver is granted either in part or in full, otherwise an empty value if the court has not yet decided
                                      • Percentage granted
                                      • URL of the court's payment system
                                      • Start and end date for the granted waiver
                                      • The EFM's unique identifier for the firm this Waiver is available for
                                      • A reference to a party for whom the waiver is being applied


                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:ParentEnvelopeID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:OutstandingBalance/nc:Amount
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverDecision
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverPercentage
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverStartDate/nc:DateTime
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverEndDate/nc:DateTime
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:FirmID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:PartyReference
                                      Related Case Other case(s) related to this case will be returned. Could be ChildCase or ParentCase
                                      • The EFM's unique identifier for the related case
                                      • The type of relation between this case and the related case

                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:ChildCase/ecf:CaseTrackingID/nc:IdentificationID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:ChildCase/tylercommon:CaseRelationType
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:ParentCase/ecf:CaseTrackingID/nc:IdentificationID
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:ParentCase/tylercommon:CaseRelationType
                                      Notification Agency The Code for the Notification Agency associated with this Case
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:CaseAugmentation/tylercommon:AgencyCode
                                      Ad Hoc Hearing Information This structure contains four element which correspond to each of the Ad Hoc Hearing flags.
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingDate
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingTime
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingLocation
                                      /filingstatusresponse:GetFilingStatusResponseMessage/ecf:MatchingFiling/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:HearingJudge



                                      CancelFiling

                                      CancelFiling cancels a filing that is pending clerk review. Once a clerk has begun the review process for a given filing it can no longer be canceled.
                                      Version2022.0
                                      RequiredCore functionality
                                      Accessible ToAny registered user. If CSM is enabled, requires the CancelSubmittedFilings resource.
                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                      ServiceFilingReviewMDEService
                                      Sample URLhttps://court.tylertech.cloud/efm/v5/filingreviewservice.svc
                                      Request Message Definitioncancel
                                      Response Message Definitioncbrn
                                      XML Samples
                                      DescriptionRequestResponse
                                      CancelFilingtyler-canceltyler-messagestatus
                                      Inputs
                                      FieldDescription
                                      Court Location Must be a valid court location identifier; however, the actual value provided does not affect the results of the API
                                      /cancel:CancelFilingMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                      Filing ID IdentificationID contains the unique EFM identifier of the desired filing
                                      /cancel:CancelFilingMessage/nc:DocumentIdentification/nc:IdentificationID
                                      Outputs
                                      FieldDescription
                                      No Outputs



                                      Filing Assembly MDE Service

                                      The Filing Assembly MDE contains APIs whereby the EFM can call back into the EFSP in order to provide notification of events that have occurred within the EFM.
                                        The EFM does not sign the SOAP headers for callbacks to the EFSP. Details regarding the Filing Assembly MDE APIs are provided below.

                                        NotifyFilingReviewComplete

                                        The EFM calls NotifyFilingReviewComplete to notify the EFSP when a filing has been either accepted or rejected, unless the envelope was part of a batch (see NotifyBatchComplete for more information). Although an EFSP may submit multiple filings to the EFM within a single envelope via the ReviewFiling API, the EFM will call the EFSP once for each filing. However, these calls will not take place until the clerk has either accepted or rejected all of the filings in the envelope. The NotifyFilingReviewComplete request includes a compound message that consists of a ReviewFilingCallbackMessage and a PaymentReceiptMessage.


                                        In addition, the EFM will call NotifyFilingReviewComplete to notify the EFSP when the court renders a decision regarding a proposed order. In this scenario, the message will pertain to the child filing as depicted in the following diagram (click to enlarge).

                                        Version2022.0
                                        RequiredCore functionality
                                        Accessible ToEFM initiates this call therefore no user context
                                        ServiceFilingAssemblyMDEService
                                        Sample URLhttps://court.tylertech.cloud/efm/v5/filingassemblyservice.svc
                                        Request Message Definitionreviewfilingcallback
                                        payment
                                        Response Message Definitioncbrn
                                        XML Samples
                                        DescriptionRequestResponse
                                        NotifyFilingReviewCompleteMessagetyler-reviewfilingcallbackrequestN/A
                                        PaymentMessagetyler-nfrc-paymentN/A
                                        NotifyFilingReviewCompletetyler-notifyfilingreviewcompletetyler-messagestatus
                                        NotifyFilingReviewComplete - Ad Hoc Hearingtyler-notifyfilingreviewcomplete-adhoc-hearingtyler-messagestatus
                                        Inputs
                                        FieldDescription
                                        Docket Date The docket date of the filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:DocumentFiledDate/nc:DateTime
                                        Filer Name The filer's name
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:DocumentAugmentation/ecf:DocumentFiler/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:DocumentAugmentation/ecf:DocumentFiler/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                        Filer Email The filer's email address
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:DocumentAugmentation/ecf:DocumentFiler/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                        Firm Name The filer's firm name
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:DocumentAugmentation/ecf:DocumentFiler/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:FirmName
                                        Submit Date/Time Date/Time the envelope was submitted
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:DocumentAugmentation/ecf:DocumentStatus/nc:StatusDate/nc:DateTime
                                        Envelope Number IdentificationID will provide the envelope number when IdentificationCategoryDescriptionText="envelopeID"
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:DocumentIdentification/nc:IdentificationID
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                        Court The Court Locations code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                        Additional Document Represents an additional document submitted as part of a filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview
                                        Filing The filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview
                                        EFMID for a Document Provides a unique EFM identifier for documents
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentIdentification/nc:IdentificationID
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentIdentification/nc:IdentificationID
                                        Filing Description Description of the Filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentDescriptionText
                                        FilingID The EFM's unique identifier for the filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentIdentification/nc:IdentificationID
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                        Container for a Document and its Metadata Represents a document - a digital file such as a PDF.
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                        Reviewer Name The name of the reviewing clerk
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:DocumentReviewDisposition/ecf:DocumentReviewer/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:DocumentReviewDisposition/ecf:DocumentReviewer/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                        Filing Component A FilingComponent code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                        Page Count Number of pages in the document
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                        Filename The filer's original filename
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                        Redacted Boolean to indicate whether the document was redacted
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                        Document Binary Contains the base64 encoded version of the document binary
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:Base64BinaryObject
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:Base64BinaryObject
                                        Description of the document Filer provided document description
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                        URL URL whereby the document may be downloaded
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                        Size File size in bytes
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                        Document Type A Document Type code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                        Filing Sequence This filing's sequence order within the envelope
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentSequenceID
                                        Document Assocation Associates a connected document to a filing. The PrimaryDocument element will refer to the associated filing.
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/nc:DocumentAssociation
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/nc:DocumentAssociation/nc:PrimaryDocument
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/nc:DocumentAssociation/ecf:DocumentAssociationAugmentation/ecf:DocumentRelatedCode
                                        Review Date The date/time the filing was reviewed
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:FilingCompletionDate/nc:DateTime
                                        Reviewer Comments The reviewer's comments regarding the acceptance or rejection of the filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:ReviewCommentsText
                                        Rejection Reason Rejection Reason Code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:FilingStatus/tylercommon:FilingStatusAugmentation/tylercommon:RejectReasonCode
                                        Filing Status The Filing Status code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:FilingStatus/ecf:FilingReviewStatusCode
                                        Filing Code The Filing code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
                                        Judge Name The judge's name
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                        Attorney An attorney involved with the case. Repeats as necessary.
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial
                                        EFMID for Attorney The EFM's unique identifier for the case party attorney
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                        Represents Provides a reference to the Case Party whom the attorney represents
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/ecf:CaseOfficialAugmentation/ecf:CaseRepresentedParty
                                        Case Category The Case Category code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                        New Case Indicates whether this was an initial case filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseNewIndicator
                                        Case Party A party to the case. Either a person or an organization
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization
                                        Party Type The Party Type code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:CaseParticipantRoleCode
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/ecf:CaseParticipantRoleCode
                                        Case Party ID The EFM's unique identifier for the case party
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/ecf:ParticipantID/nc:IdentificationID
                                        Address Line 2 Line two of the address
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine
                                        Street Address The street address
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                        City The city portion of the address
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                        State The State code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                        Country The Country code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                        Zip Code The zip code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                        Email The case party's email address
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactEmailID
                                        Phone The case party's phone number
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactTelephoneNumber/nc:FullTelephoneNumber/nc:TelephoneNumberFullID
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactTelephoneNumber/nc:FullTelephoneNumber/nc:TelephoneNumberFullID
                                        EFMID for Case The EFM's unique identifier for the case
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                        Case Type The Case Type code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                        Case Number The court case number
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                        Case Status The Case Status code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/tylercommon:CaseAugmentation/nc:StatusText
                                        Case Filed Date The date the case was filed
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:FiledDate/nc:Date
                                        Notification Agency The Code for the Notification Agency associated with this Case
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:AgencyCode
                                        Parent Envelope The parent envelope number
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:ParentEnvelope/tylercommon:EnvelopeID
                                        Parent FilingID The EFM's unique identifier for the parent filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:ParentEnvelope/tylercommon:FilingID
                                        Parent Submitter ID The EFM's unique identifier for the submitter of the parent envelope
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:ParentEnvelope/tylercommon:Submitter/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                        Parent Submitter Email The email address for the submitter of the parent envelope
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:ParentEnvelope/tylercommon:Submitter/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                        Filing Party The EFM's identifier for the party responsible for fees associated with the filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:FilingParty/tylercommon:PartyIdentification/nc:IdentificationID
                                        Filing Attorney The EFM's identifier for the attorney on record for the filing
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:FilingAttorney/tylercommon:AttorneyIdentification/nc:IdentificationID
                                        Filer Type The Filer Type code
                                        /reviewfilingcallback:NotifyFilingReviewCompleteMessage/tylercommon:NotifyFilingMessageAugmentation/tylercommon:FilerTypeCode
                                        AllowanceCharge A series of AllowanceCharge elements provides a breakdown of the fees. Refer to the GetFeesCalculation API for more information.
                                        /payment:PaymentMessage/cac:AllowanceCharge
                                        Payment The ID element contains the order number for any payment transaction that took place.
                                        /payment:PaymentMessage/cac:Payment/cbc:ID
                                        Paid Amount The amount paid
                                        /payment:PaymentMessage/cac:Payment/cbc:PaidAmount
                                        Paid Date The date of the payment
                                        /payment:PaymentMessage/cac:Payment/cbc:PaidDate
                                        Paid Time The time of the payment
                                        /payment:PaymentMessage/cac:Payment/cbc:PaidTime
                                        Grace Period Expiration Date Alloted time/date for an envelope to allow the filer to retain their original docket date if they resubmit within the grace period
                                        /NotifyFilingReviewCompleteRequest/reviewfilingcallback:NotifyFilingReviewCompleteMessage/ecf:FilingStatus/tyler:FilingStatusAugmentation/tyler:GracePeriodExpirationDate
                                        Outputs
                                        FieldDescription
                                        No Outputs



                                        NotifyCourtDate

                                        NOTE: This API is currently restricted for use solely within the eFileIL market.
                                        NotifyCourtDate notifies the FilingAssembly MDE that a hearing has been scheduled. This API is applicable in two scenarios:
                                        • if the CMS automatically scheduled a hearing as a result of a filing
                                        • if the filer requested a hearing, which can only occur for court locations that have AllowHearing = True.
                                        Version2022.0
                                        RequiredConditional functionality, subject to business requirements
                                        Accessible ToEFM initiates this call therefore no user context
                                        ServiceFilingAssemblyMDEService
                                        Sample URLhttps://court.tylertech.cloud/efm/v5/filingassemblyservice.svc
                                        Request Message DefinitionDateCallback
                                        Response Message Definitioncbrn
                                        XML Samples
                                        DescriptionRequestResponse
                                        NotifyCourtDatetyler-datecallbacktyler-messagestatus
                                        Inputs
                                        FieldDescription
                                        Envelope Number The envelope number to which this hearing pertains
                                        /datecallback:NotifyCourtDateMessage/nc:DocumentIdentification/nc:IdentificationID
                                        Court Location The court location of the case to which this hearing pertains
                                        /datecallback:NotifyCourtDateMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                        Hearing Date/Time The start and end time of the hearing
                                        /datecallback:NotifyCourtDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtSchedule/tylercommon:ScheduleDayStartTime/nc:DateTime
                                        /datecallback:NotifyCourtDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtSchedule/tylercommon:ScheduleDayEndTime/nc:DateTime
                                        Courtroom The courtroom where the hearing will be held
                                        /datecallback:NotifyCourtDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtRoom
                                        Address The physical address where the hearing will be held
                                        /datecallback:NotifyCourtDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtStreet
                                        /datecallback:NotifyCourtDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtCityStateZip
                                        Case ID The EFM's unique id for the case to which this hearing pertains
                                        /datecallback:NotifyCourtDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                        Outputs
                                        FieldDescription
                                        No Outputs



                                        Court Record MDE Service

                                        The Court Record MDE enables an EFSP to query the EFM for information pertaining to existing cases. If the jurisdiction's Case Management System is integrated with the EFM, the EFM will request case information from the Case Management System. Otherwise, the EFM will provide the information it has about the case. Service information is maintained solely with the EFM, not the Case Management System.
                                          The EFM does not support the ECF GetDocument API. Details regarding the Court Record MDE APIs are provided below.

                                          GetCaseList

                                          GetCaseList queries for a list of cases within a particular jurisdiction, matching on either the case number or a case participant's name. A search by case participant name is a search for an individual or an organization, not an individual within an organization. If the clerk's Case Management System is integrated with the EFM, this query will be forwarded to the CMS, otherwise the EFM will perform the query locally against its own indexes of known cases.

                                          The intent for this call is to retrieve a subset of cases, not a complete historical record of all cases for the specified criteria. Therefore, the EFM imposes an upper limit of 1000 results, where the returns are the most recent cases by date filed. The sort order of the selection and results are by descending date filed (reverse chronological) order.

                                          The case information may be dependent upon an integration to a clerk CMS. When an integration does not exist, the EFM will provide information about the cases that have been e-filed thus far. When an integration exists but is temporarily unavailable, the EFM will provide the most recent information it has

                                          Version2022.0
                                          RequiredCore functionality
                                          Accessible ToAny registered user. If CSM is enabled, requires the ViewCase resource.
                                          User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                          ServiceCourtRecordMDEService
                                          Sample URLhttps://court.tylertech.cloud/efm/v5/courtrecordservice.svc
                                          Request Message Definitioncaselistrequest
                                          Response Message Definitioncaselistresponse
                                          XML Samples
                                          DescriptionRequestResponse
                                          Query by Case Numbertyler-caselistrequest-casenumbertyler-efsp-caselistresponse
                                          Query by Person Nametyler-caselistrequest-partytyler-efsp-caselistresponse-multiple
                                          Query by Case Number - Appellatetyler-caselistrequest-partytyler-efsp-caselistresponse-appellate
                                          Inputs
                                          FieldDescription
                                          Court Location A valid court location identifier. For sites with the ability to search across all locations, use a location identifier of 1 to perform such a search. Refer to the AdvancedSearchLocationAllLocations data field configuration code for more information
                                          /caselistrequest:GetCaseListRequestMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                          Case Nunber Search by court case number
                                          /caselistrequest:GetCaseListRequestMessage/caselistrequest:CaseListQueryCriteria/tylercommon:CaseListQueryCriteriaAugmentation/j:CaseNumberText
                                          Case Party Search by case party name
                                          /caselistrequest:GetCaseListRequestMessage/caselistrequest:CaseListQueryCriteria/caselistrequest:CaseParticipant/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                          /caselistrequest:GetCaseListRequestMessage/caselistrequest:CaseListQueryCriteria/caselistrequest:CaseParticipant/nc:EntityPerson/nc:PersonName/nc:PersonMiddleName
                                          /caselistrequest:GetCaseListRequestMessage/caselistrequest:CaseListQueryCriteria/caselistrequest:CaseParticipant/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                          /caselistrequest:GetCaseListRequestMessage/caselistrequest:CaseListQueryCriteria/caselistrequest:CaseParticipant/nc:EntityOrganization/nc:OrganizationName
                                          Outputs
                                          FieldDescription
                                          Error For court locations that provide the EFM with the ability to search for cases, the EFM will call upon the CMS to do so. If the call to the CMS fails, the EFM will search its own records to provide results, and will return error -11.

                                          For court locations that do not provide the EFM with the ability to search for cases, the EFM will search its own records. If no results are found, the EFM will return error code 136. This indicates that the filer may still file into cases not found (as a filing into a non-indexed case)

                                          Case Zero, one, or many cases returned for the case search.
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case
                                          Court Location The court location identifier for the case.
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                          Case Title The style or title of the case
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case/nc:CaseTitleText
                                          Case Category The case category code as defined in the Case Category code list
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                          Case ID The unique EFM identifier for the case
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                          Case Type The case category code as defined in the case type code list
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                          Court Case Number The court's case number for the case
                                          /caselistresponse:GetCaseListResponseMessage/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                          BlackoutStatus When a court location is in a blackout, the following will be returned:
                                          • CaseCourt - a court location identifier
                                          • ReasonDescriptionText - the reason entered for the blackout
                                          • BlackoutDate - the Start and End dates

                                          /caselistresponse:GetCaseListResponseMessage/cbrn:MessageStatus/MessageStatusAugmentation



                                          GetCase

                                          GetCase queries for a case by the EFM's case identifier, which the EFSP obtains from the GetCaseList API. An EFSP must not cache case data; rather, the EFSP should always invoke the GetCase API to retrieve the latest information about the case.

                                          The case information may be dependent upon an integration to a clerk CMS. When an integration does not exist, the EFM will provide information about the cases that have been e-filed thus far. When an integration exists but is temporarily unavailable, the EFM will provide the most recent information it has

                                          Version2022.0
                                          RequiredCore functionality
                                          Accessible ToAny registered user. If CSM is enabled, requires the ViewCase resource.
                                          User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                          ServiceCourtRecordMDEService
                                          Sample URLhttps://court.tylertech.cloud/efm/v5/courtrecordservice.svc
                                          Request Message Definitioncaserequest
                                          Response Message Definitioncaseresponse
                                          XML Samples
                                          DescriptionRequestResponse
                                          GetCasetyler-efsp-caserequesttyler-efsp-caseresponse
                                          GetCasetyler-efsp-caserequesttyler-efsp-caseresponse-appellate
                                          Inputs
                                          FieldDescription
                                          Court Location A Court Location code
                                          /caserequest:GetCaseRequestMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                          Case ID The EFMID of the case
                                          /caserequest:GetCaseRequestMessage/caserequest:CaseQueryCriteria/ecf:CaseTrackingID/nc:IdentificationID
                                          Return case participants A boolean to indicate whether to return case parties
                                          /caserequest:GetCaseRequestMessage/caserequest:CaseQueryCriteria/caserequest:IncludeParticipantsIndicator
                                          Outputs
                                          FieldDescription
                                          Error If the court location provides the ability for the EFM to load cases from the CMS, the EFM will do so. However, there are several possible error code indicators:
                                          • Error 130 - the CMS reports that the case is unavailable for e-filing due to the case being secured
                                          • Error -10 - the EFM was unable to reach the CMS therefore case information is sourced from the EFM and thus may be stale
                                          Case Title The case title
                                          /caseresponse:GetCaseResponseMessage/nc:Case/nc:CaseTitleText
                                          Court Location A Court Location code
                                          /caseresponse:GetCaseResponseMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                          Judge Name The judge's name
                                          /caseresponse:GetCaseResponseMessage/nc:Case/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                          Attorney A CaseOfficial element should exist for any attorney representing a party on the case. If an attorney represents multiple parties on the case, this element should be repeated for each party.. IdentificationID provides the EFM identifier for the case party attorney
                                          CaseRepresentedParty associates the attorney to the party being represented.

                                          The system can support multiple Case Party Attorney records for each CaseParty. This capability is enabled by default but can be disabled per court location.

                                          One such Case Party Attorney is designated as the lead attorney via the IsLead element. If multiple Case Party Attorneys are specified for a Case Party, one and only one must be designated as the lead. A case party's lead attorney cannot be changed via e-filing.

                                          /caseresponse:GetCaseResponseMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/tylercommon:PersonAugmentation/tylercommon:AttorneyIdentification/nc:IdentificationID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/ecf:CaseOfficialAugmentation/ecf:CaseRepresentedParty
                                          /caseresponse:GetCaseResponseMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/tylercommon:CaseOfficialAugmentation/tylercommon:IsLead

                                          Bar Number The attorney's bar number
                                          /caseresponse:GetCaseResponseMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/j:JudicialOfficialBarMembership/j:JudicialOfficialBarIdentification/nc:IdentificationID
                                          Case Category Case Category code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                          Case Party This structure defines a party that is associated to the case. In some cases, such as class action suits, the CMS may elect to artificially limit the number of parties returned and/or to limit the party detail information.
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty
                                          Person or Organization A case party is either a person or an organization
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization
                                          Case Party Name The case party's name.
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonMiddleName
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/nc:OrganizationName
                                          Party Type A Party Type code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:CaseParticipantRoleCode
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/ecf:CaseParticipantRoleCode
                                          Address Line2 Line 2 of the adddress
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/tylercommon:AddressSecondaryLine
                                          Street Address The street address
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/
                                          City The city portion of the address
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/nc:LocationCityName
                                          State A State code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/nc:LocationStateName
                                          Country A Country code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/tylercommon:AddressAugmentation/nc:LocationCountryName
                                          Zip The zip code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                          Case Party ID The EFM's unique identifier for the party
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:PartyIdentification/nc:IdentificationID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/tylercommon:PartyIdentification/nc:IdentificationIDionPostalCode
                                          Filer ID The filer ID for the case party
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:FilerIdentification/nc:IdentificationID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/tylercommon:FilerIdentification/nc:IdentificationID
                                          Agency Provides the FirmID of an agency that is attached to the party
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:Agency/tylercommon:FirmID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/tylercommon:Agency/tylercommon:FirmID
                                          "I am this Party" Indicator Provides the EFM's unique identifier for the filer that has claimed this party. Is ommitted when a party is unclaimed.
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:PartyUserIdentification/nc:IdentificationID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/ecf:OrganizationAugmentation/tylercommon:PartyUserIdentification/nc:IdentificationID
                                          Case ID The EFM's unique identifier for the case
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                          Case Type A Case Type code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                          Court Case Number The court's case number
                                          /caseresponse:GetCaseResponseMessage/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                          Case Sub Type The Case Sub Type code
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:CaseSubTypeCode
                                          Case Status A free text value to represent the status of the case.

                                          NOTE: This field will only be populated if the CMS provides it to the EFM.
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/nc:StatusText

                                          Case Filed Date The date the case was filed
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:FiledDate/nc:Date
                                          Partial Waiver Provides details in regard to a standing waiver request that is either pending or has been granted by the court. Requests that have been denied by the court will not be returned.
                                          • Outstanding balance - any remaining balance due from a filing whereby a standing waiver was requested
                                          • Court decision - GRANT if a waiver is granted either in part or in full, otherwise an empty value if the court has not yet decided
                                          • Percentage granted
                                          • URL of the court's payment system
                                          • Start and end date for the granted waiver
                                          • The EFM's unique identifier for the firm this Waiver is available for
                                          • A reference to a party for whom the waiver is being applied


                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:OutstandingBalance/nc:Amount
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverDecision
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverPercentage
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:PaymentSystemURL
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverStartDate/nc:DateTime
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:WaiverEndDate/nc:DateTime
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:FirmID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:PartialWaiver/tylercommon:PartyReference
                                          Damage Amount The damage amount
                                          /caseresponse:GetCaseResponseMessage/nc:Case/civil:CaseAugmentation/civil:AmountInControversy/nc:Amount
                                          Lower Court Name The court name of the case in the lower court
                                          /caseresponse:GetCaseResponseMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:CaseAugmentation/j:CaseCourt/nc:OrganizationName
                                          Lower Court Judge The judge name of the case in the lower court
                                          /caseresponse:GetCaseResponseMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                          Lower Court Case Category The case category of the case in the lower court
                                          /caseresponse:GetCaseResponseMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                          Lower Court Case Type The case type of the case in the lower court
                                          /caseresponse:GetCaseResponseMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/ecf:CaseAugmentation/ecf:CaseTypeCode
                                          Lower Court Case Number The case number of the case in the lower court
                                          /caseresponse:GetCaseResponseMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:CaseAugmentation/j:CaseLineageCase/ecf:CaseAugmentation/j:CaseNumberText
                                          Lower Court Case Title The case title of the case in the lower court
                                          /caseresponse:GetCaseResponseMessage/nc:Case/appellate:CaseAugmentation/j:AppellateCase/j:AppellateCaseOriginalCase/nc:CaseTitleText
                                          HasUserFiledIntoCaseIndicatorBoolean to indicate if the calling user has ever filed into the case
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation
                                          Related Case Other case(s) related to this case will be returned. Could be ChildCase or ParentCase
                                          • The EFM's unique identifier for the related case
                                          • The type of relation between this case and the related case

                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:ChildCase/ecf:CaseTrackingID/nc:IdentificationID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:ChildCase/tylercommon:CaseRelationType
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:ParentCase/ecf:CaseTrackingID/nc:IdentificationID
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:ParentCase/tylercommon:CaseRelationType
                                          Notification Agency The Code for the Notification Agency associated with this Case
                                          /caseresponse:GetCaseResponseMessage/nc:Case/tylercommon:CaseAugmentation/tylercommon:AgencyCode
                                          BlackoutStatus When a court location is in a blackout, the following will be returned:
                                          • CaseCourt - a court location identifier
                                          • ReasonDescriptionText - the reason entered for the blackout
                                          • BlackoutDate - the Start and End dates

                                          /caseresponse:GetCaseResponseMessage/cbrn:MessageStatus



                                          GetDocument

                                          GetDocument is not supported. Documents are only supported within the context of a filing.


                                          GetServiceInformation

                                          GetServiceInformation retrieves a list of service contacts that have been attached to the case or the case parties.
                                          Version2022.0
                                          RequiredCore functionality
                                          Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                                          User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                          ServiceCourtRecordMDEService
                                          Sample URLhttps://court.tylertech.cloud/efm/v5/courtrecordservice.svc
                                          Request Message Definitionserviceinformationrequest
                                          Response Message Definitionserviceinformationresponse
                                          XML Samples
                                          DescriptionRequestResponse
                                          Service Information for a Casetyler-efsp-serviceinformationrequesttyler-efsp-serviceinformationresponse
                                          Inputs
                                          FieldDescription
                                          Court Location The Court Location code of the case
                                          /serviceinformationrequest:GetServiceInformationRequestMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                          Case ID Unique EFM identifier for the case
                                          /serviceinformationrequest:GetServiceInformationRequestMessage/ecf:CaseTrackingID/nc:IdentificationID
                                          Court Location The Court Location code of the case
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                          Outputs
                                          FieldDescription
                                          Service Contact Identifies a service contact that is attached to the case. This element will be repeated for each service contact that is attached to the case.
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient
                                          Name The first and last name of the service contact
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                          EFM identifier The unique EFM identifier for the service recipient
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/tylercommon:ServiceContactID/nc:IdentificationID
                                          Case Party Attached The CaseRepresentedParty structure provides a link between a service contact and a case party, if applicable. This structure may repeat as needed.
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/ecf:CaseRepresentedParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/ecf:CaseRepresentedParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationCategoryDescriptionText
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/ecf:CaseRepresentedParty/nc:EntityOrganization/ecf:OrganizationAugmentation/ecf:ParticipantID/nc:IdentificationID
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/ecf:CaseRepresentedParty/nc:EntityOrganization/ecf:OrganizationAugmentation/ecf:ParticipantID/nc:IdentificationCategoryDescriptionText
                                          Firm Name The name of the firm to which the service contact belongs, of "Individual" if associated to a non-firm account
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:FirmName
                                          Mail Service Indicator Indicates that this service contact is a mail service contact and should not receive eService.
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/tylercommon:PersonAugmentation/tylercommon:MailServiceIndicator
                                          Public Indicates that the service contact belongs to the public service contact list
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/tylercommon:IsPublic
                                          Master Indicates that the service contact belongs to the owning firm's master service contact list
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/tylercommon:IsInFirmMasterList
                                          Owned By Provides the EFM's firm identifier that owns this service contact
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/tylercommon:OwnedByFirmIdentification/nc:IdentificationID
                                          Email The email address for the service contact A second ContactEmailID reflects the administrative copy email.
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID
                                          Phone The telephone number for the service contact
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactTelephoneNumber/nc:FullTelephoneNumber/nc:TelephoneNumberFullID
                                          CaseParty The EFM identifier for the case party to which the service contact is attached
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/ecf:ElectronicServiceInformation/tylercommon:ElectronicServiceAugmentation/tylercommon:ServiceRecipient/ecf:CaseRepresentedParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationCategoryDescriptionText
                                          Address The address for the service contact
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCountry/nc:LocationCountryName
                                          /serviceinformationresponse:GetServiceInformationResponseMessage/serviceinformationresponse:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode



                                          Service MDE Service

                                          The Service MDE Service contains a single API for the purpose of initiating e-service without submitting a filing to the court.
                                            Details of the Service MDE Service API are provided below.

                                            ServeFiling

                                            ServeFiling submits a request for the EFM to perform electronic service only. The filing will not be submitted to the court.

                                            The request message is a FilingMessage. Please refer to ReviewFiling for more details about the FilingMessage. Since ECF does not define a Payment message for use with ServeFiling, any EFSP fees would be passed in via Tyler extensions within the CaseAugmentation element.

                                            The EFM asychronously invokes the NotifyFilingReviewComplete API for each filing as a callback to the EFSP to communicate the outcome of each filing.

                                            ServeFiling is not supported for:

                                            • non-indexed cases
                                            • filings that add a new party
                                            Version2022.0
                                            RequiredCore functionality
                                            Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelopes resource.
                                            User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                            ServiceServiceMDEService
                                            Sample URLhttps://court.tylertech.cloud/efm/v5/service.svc
                                            Request Message Definitionfiling
                                            Response Message Definitioncbrn
                                            XML Samples
                                            DescriptionRequestResponse
                                            ServeFilingtyler-servefilingrequest[ Invalid Link ]tyler-servefiling-response
                                            Inputs
                                            FieldDescription
                                            *** Refer to the Filing Message portion of the ReviewFiling API ***
                                            Charge Fees An indicator that the EFSP is charging fees for service.
                                            /payment:PaymentMessage/cac:AllowanceCharge/cbc:ChargeIndicator
                                            Fee Amount The EFSP fee amount to charge for service
                                            /payment:PaymentMessage/cac:AllowanceCharge/cbc:Amount
                                            Tax Percentage The percentage used to calculate the tax due
                                            /payment:PaymentMessage/cac:AllowanceCharge/cac:TaxCategory/cbc:Percent
                                            Tax Amount The amount of tax to collect for the EFSP fee
                                            /payment:PaymentMessage/cac:AllowanceCharge/cac:TaxTotal/cbc:TaxAmount
                                            Payment Account ID The EFM identifier for the payment account to charge
                                            /payment:PaymentMessage/cac:AllowanceCharge/cac:PaymentMeans/cbc:PaymentID
                                            Outputs
                                            FieldDescription
                                            Envelope Number IdentificationID provides the envelope number when IdentificationCategoryDescriptionText=envelopeID
                                            /cbrn:MessageStatus/ecf:MessageStatusAugmentation/nc:DocumentIdentification/nc:IdentificationID
                                            /cbrn:MessageStatus/ecf:MessageStatusAugmentation/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText



                                            ServeProcess

                                            ServeProcess is not supported.


                                            Court Scheduling MDE Service

                                            The Court Scheduling MDE contains APIs for the purpose of scheduling activities with the court.
                                              Details of the Court Scheduling MDE APIs are provided below.

                                              GetCourtSchedule

                                              GetCourtSchedule is not currently supported by the EFM.


                                              RequestCourtDate

                                              NOTE: This API is currently restricted for use solely within the eFileIL market.
                                              RequestCourtDate requests available hearing dates for a case. One hearing date is allowed per envelope. This API is only available for court locations where AllowHearing = True. The hearing request must pertain to an existing envelope that has one or more filings in any of the following states:
                                              • Submitting
                                              • Submitted
                                              • Under Review
                                              Furthermore, the user requesting the hearing must belong to envelope submitter's firm.
                                              Version2022.0
                                              RequiredConditional functionality, subject to business requirements
                                              Accessible ToAny registered user. If CSM is enabled, requires the ScheduleHearing resource.
                                              ServiceCourtSchedulingMDEService
                                              Sample URLhttps://court.tylertech.cloud/efm/v5/courtschedulingservice.svc
                                              Request Message Definitionrequestdaterequest
                                              Response Message Definitionrequestdateresponse
                                              XML Samples
                                              DescriptionRequestResponse
                                              RequestCourtDatetyler-requestdatetyler-requestdateresponse
                                              Inputs
                                              FieldDescription
                                              Envelope Number The envelope number of the envelope to which the hearing request pertains
                                              /requestdaterequest:RequestCourtDateRequestMessage/nc:DocumentIdentification/nc:IdentificationID
                                              /requestdaterequest:RequestCourtDateRequestMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                              Court Location The court location identifier for the case to which the hearing request pertains
                                              /requestdaterequest:RequestCourtDateRequestMessage/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                              Estimated Duration Indicates an estimated duration for the requested hearing
                                              /requestdaterequest:RequestCourtDateRequestMessage/reservedate:EstimatedDuration
                                              The StartDate and EndDate reflect a time range for the requested hearing
                                              /requestdaterequest:RequestCourtDateRequestMessage/reservedate:PotentialStartTimeRange/nc:StartDate/nc:DateTime
                                              /requestdaterequest:RequestCourtDateRequestMessage/reservedate:PotentialStartTimeRange/nc:EndDate/nc:DateTime
                                              Outputs
                                              FieldDescription
                                              Envelope Number The envelope number
                                              /requestdateresponse:RequestCourtDateResponseMessage/nc:DocumentIdentification/nc:IdentificationID
                                              Court Location The court location
                                              /requestdateresponse:RequestCourtDateResponseMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                              Court Date Will occur zero, one, or many times to represent available court dates.
                                              /requestdateresponse:RequestCourtDateResponseMessage/requestdateresponse:CourtDate
                                              /requestdateresponse:RequestCourtDateResponseMessage/requestdateresponse:CourtDate/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtSchedule/tylercommon:ScheduleDayStartTime/nc:DateTime
                                              /requestdateresponse:RequestCourtDateResponseMessage/requestdateresponse:CourtDate/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:CourtSchedule/tylercommon:ScheduleDayEndTime/nc:DateTime



                                              ReserveCourtDate

                                              NOTE: This API is currently restricted for use solely within the eFileIL market.
                                              ReserveCourtDate requests a hearing date for a case. This API is only called if the EFM is configured to do so for the court location. One hearing date is allowed per envelope. This API is only available for court locations where AllowHearing = True. The hearing request must pertain to an existing envelope that has one or more filings in any of the following states:
                                              • Submitting
                                              • Submitted
                                              • Under Review
                                              Furthermore, the user requesting the hearing must belong to envelope submitter's firm. The message flow is depicted in the following diagram (click to enlarge).

                                              Version2022.0
                                              RequiredConditional functionality, subject to business requirements
                                              Accessible ToAny registered user. If CSM is enabled, requires the ScheduleHearing resource.
                                              User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                              ServiceCourtSchedulingMDEService
                                              Sample URLhttps://court.tylertech.cloud/efm/v5/courtschedulingservice.svc
                                              Request Message Definitionreservedate
                                              Response Message Definitioncbrn
                                              XML Samples
                                              DescriptionRequestResponse
                                              ReserveCourtDatetyler-reservedatetyler-messagestatus
                                              Inputs
                                              FieldDescription
                                              Envelope Number The envelope number of the envelope to which the hearing request pertains
                                              /reservedate:ReserveCourtDateMessage/nc:DocumentIdentification/nc:IdentificationID
                                              /reservedate:ReserveCourtDateMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                              Court Location The court location identifier for the case to which the hearing request pertains
                                              /reservedate:ReserveCourtDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                              Estimated Duration Indicates an estimated duration for the requested hearing
                                              /reservedate:ReserveCourtDateMessage/reservedate:EstimatedDuration
                                              Time Range The StartDate and EndDate reflect a time range for the requested hearing
                                              /reservedate:ReserveCourtDateMessage/reservedate:PotentialStartTimeRange/nc:StartDate/nc:DateTime
                                              /reservedate:ReserveCourtDateMessage/reservedate:PotentialStartTimeRange/nc:EndDate/nc:DateTime
                                              Outputs
                                              FieldDescription
                                              Error If a hearing is unable to be reserved, the EFM will relay any error code and error message from the CMS
                                              /cbrn:MessageStatus/cbrn:MessageHandlingError/cbrn:ErrorCodeText
                                              /cbrn:MessageStatus/cbrn:MessageStatusCode
                                              Hearing ID The unique number of the hearing
                                              /cbrn:MessageStatus/ecf:MessageStatusAugmentation/nc:DocumentIdentification/nc:IdentificationID
                                              /cbrn:MessageStatus/ecf:MessageStatusAugmentation/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText



                                              Tyler Extension: Filing Review MDE Service

                                              The Tyler Extension Filing Review MDE Service contains APIs that Tyler has added to provide additional capabilities beyond what is defined within the ECF MDE.
                                                Details of the Tyler Extension Filing Review MDE Service APIs are provided below. are provided below.

                                                GetServiceTypes

                                                GetServiceTypes provides service contact types applicable to a filing. This API is only applicable for court locations where HasConditionalServiceTypes = 1, in which case the response should be used in lieu of the system-wide service type code list.
                                                Version2022.0
                                                RequiredConditional functionality, subject to business requirements
                                                Accessible ToAny registered user. If CSM is enabled, requires the SubmitEnvelopes resource.
                                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                ServiceTylerFilingReviewMDEService
                                                Sample URLhttps://court.tylertech.cloud/efm/v5/tylerfilingreviewservice.svc
                                                Request Message Definitionservicetyperequest
                                                Response Message Definitionservicetyperesponse
                                                XML Samples
                                                DescriptionRequestResponse
                                                GetServiceTypestyler-servicetypestyler-servicetypesresponse
                                                Inputs
                                                FieldDescription
                                                Court Location The court locations
                                                /servicetypesrequest:GetServiceTypesMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                Caes Type Code The Case Type code
                                                /servicetypesrequest:GetServiceTypesMessage/ecf:CaseTypeCode
                                                New Case Indicator Indicates whether this is for filing a new case
                                                /servicetypesrequest:GetServiceTypesMessage/ecf:CaseNewIndicator
                                                Filing Code The Filing code
                                                /servicetypesrequest:GetServiceTypesMessage/ecf:RegisterActionDescriptionCode
                                                Amount in Controversy The damage amount
                                                /servicetypesrequest:GetServiceTypesMessage/civil:AmountInControversy/nc:Amount
                                                Outputs
                                                FieldDescription
                                                ServiceCodeID Unique EFM identifier for the code
                                                /servicetypesresponse:GetServiceTypesResponseMessage/servicetypesresponse:ServiceType/servicetypesresponse:ServiceCodeID
                                                Description Description of the service type
                                                /servicetypesresponse:GetServiceTypesResponseMessage/servicetypesresponse:ServiceType/servicetypesresponse:Description
                                                IsEmailRequired Boolean to indicate whether this service contact type requires an email address
                                                /servicetypesresponse:GetServiceTypesResponseMessage/servicetypesresponse:ServiceType/servicetypesresponse:IsEmailRequired
                                                IsStreetAddressRequired Boolean to indicate whether this service contact type requires a street address
                                                /servicetypesresponse:GetServiceTypesResponseMessage/servicetypesresponse:ServiceType/servicetypesresponse:IsStreetAddressRequired



                                                GetFilingService

                                                GetFilingService provides SMTP logs for a particular filing/service contact combination.
                                                Version2022.0
                                                RequiredConditional functionality, subject to business requirements
                                                Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                ServiceTylerFilingReviewMDEService
                                                Sample URLhttps://court.tylertech.cloud/efm/v5/tylerfilingreviewservice.svc
                                                Request Message Definitionfilingservicerequest
                                                Response Message Definitionfilingserviceresponse
                                                XML Samples
                                                DescriptionRequestResponse
                                                GetFilingServicetyler-filingservicetyler-filingserviceresponse
                                                Inputs
                                                FieldDescription
                                                FilingID Unique EFM identifier for the filing
                                                /filingservice:GetFilingServiceMessage/nc:DocumentIdentification/nc:IdentificationID
                                                ServiceContactID Unique EFM identifier for the service contact
                                                /filingservice:GetFilingServiceMessage/ecf:ServiceRecipientID/nc:IdentificationID
                                                Outputs
                                                FieldDescription
                                                Mail Service Indicator Boolean to indicate that service is via postal mail. If the value is true, the address will be included in the ServiceRecipientDetail element. If the value is true, the SmptLog will not be present.
                                                /filingserviceresponse:GetFilingServiceResponseMessage/filingserviceresponse:MailServiceIndicator
                                                Tracking Number Tracking number issued by USPS
                                                /filingserviceresponse:GetFilingServiceResponseMessage/filingserviceresponse:TrackingNumber
                                                SMTP Log SMTP log information, enclosed in a CDATA section
                                                /filingserviceresponse:GetFilingServiceResponseMessage/filingserviceresponse:SmtpLog



                                                GetBatchList

                                                GetBatchList provides the ability to search for batches. Results are sorted in reverse chronological order.

                                                This API only applies to batch filing (available in limited jurisdictions).

                                                Version2022.0
                                                RequiredConditional functionality, subject to business requirements
                                                Accessible ToAny registered user. If CSM is enabled, requires the SubmitBatchEnvelopes resource.
                                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                ServiceTylerFilingReviewMDEService
                                                Sample URLhttps://court.tylertech.cloud/efm/v5/tylerfilingreviewservice.svc
                                                Request Message Definitionbatchlistrequest
                                                common
                                                Response Message Definitionbatchlistresponse
                                                common
                                                XML Samples
                                                DescriptionRequestResponse
                                                GetBatchListtyler-batchlisttyler-batchlistresponse
                                                Inputs
                                                FieldDescription
                                                Date Range Provides the ability to search for batches submitted within a specific date range
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/nc:DateRange/nc:StartDate/nc:Date
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/nc:DateRange/nc:EndDate/nc:Date
                                                Status Provides the ability to search for batches with a particular status
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/tylercommon:BatchStatusCode
                                                Pagination Provides the ability to receive a paginated subset of search results. The EFM enforces a maximum PageSize of 100.
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/tylercommon:PagingAugmentation/tylercommon:PageIndex
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/tylercommon:PagingAugmentation/tylercommon:PageSize
                                                BatchID IdentificationID provides the ability to search for a batch using the EFSP's unique batch identifier. BatchID specifies the unique EFM batch identifier
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/tylercommon:BatchIdentification/nc:IdentificationID
                                                Court Location Provides the ability to search for batches submitted for a particular court location
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                Case Category Provides the ability to search for batches submitted for a particular case category
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/ecf:CaseCategoryCode
                                                Case Type Provides the ability to search for batches submitted for a particular case type
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/ecf:CaseTypeCode
                                                Filing Code Provides the ability to search for batches submitted for a particular filing code
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/ecf:RegisterActionDescriptionCode
                                                All Batches by Firm Include batches by all users in the submitter's firm
                                                /batchlistrequest:GetBatchListMessage/batchlistrequest:BatchListQueryCriteria/batchlistrequest:IncludeFirmsBatchIndicator
                                                Outputs
                                                FieldDescription
                                                Batch Represents a batch within the search results
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch
                                                Batch IDs IdentificationID provides the EFSP's batch identifier. BatchID provides the EFM's batch identifier.
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:BatchIdentification/nc:IdentificationID
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:BatchIdentification/tylercommon:BatchID
                                                Status Current status of the batch. Possible values are:

                                                • Submitting - the batch has been partially submitted
                                                • Submitted - all filings in the batch have been submitted for clerk review
                                                • UnderReview - the batch is under clerk review
                                                • Processing - the batch is being processed after clerk review
                                                • Accepted - all filings in the batch have been successfully accepted
                                                • Returned - all filings in the batch have been rejected
                                                • SubmissionFailed - one or more filings in the batch have failed

                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:BatchStatus/tylercommon:BatchStatusCode
                                                Batch Submission Date Timestamp the batch was created (via the first envelope of the batch)
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/nc:DocumentFiledDate/nc:DateTime
                                                Envelope Case information representing one envelope/filing contained in the batch. Depending upon the batch usage characteristics this may or may not be of use. For a batching model where filings are homogeneous this provides a mechanism for identifying a representative envelope/filing without having to call the GetBatchDetail API
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope
                                                Order Order of the envelope in the batch
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/tylercommon:BatchSequence
                                                Envelope Number The envelope number
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/tylercommon:EnvelopeIdentification/nc:IdentificationID
                                                Case Case information associated with the one filing
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/nc:Case
                                                Court Location The Court Location code of the case
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                Court Name The court name
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/nc:Case/j:CaseAugmentation/j:CaseCourt/j:CourtName
                                                Case Category The Case Category code
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                                Case Type The Case Type code
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                                Submit Date The date/time the envelope was submitted
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:Envelope/nc:Case/tylercommon:CaseAugmentation/tylercommon:FiledDate/nc:DateTime
                                                Batch Size The size of the batch
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/batchlistresponse:BatchSize
                                                Total Fees Total fee amount for the batch
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/batchlistresponse:TotalFees/nc:Amount
                                                Hearing Date The start/end date/time for the hearing
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:CourtSchedule/tylercommon:ScheduleDayStartTime/nc:DateTime
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:CourtSchedule/tylercommon:ScheduleDayEndTime/nc:DateTime
                                                Location Location of the hearing
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:CourtRoom
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:CourtStreet
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:CourtCityStateZip
                                                Filing Code The Filing code
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:FilingCode
                                                Motion Type The Motion Type code
                                                /batchlistresponse:GetBatchListResponseMessage/batchlistresponse:Batch/tylercommon:HearingSchedule/tylercommon:MotionTypeCode



                                                GetBatchDetail

                                                GetBatchDetail provides the ability to obtain additional information about a batch and its envelopes/filings.

                                                This API only applies to batch filing (available in limited jurisdictions).

                                                Version2022.0
                                                RequiredConditional functionality, subject to business requirements
                                                Accessible ToAny registered user. If CSM is enabled, requires the SubmitBatchEnvelopes resource.
                                                User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                ServiceTylerFilingReviewMDEService
                                                Sample URLhttps://court.tylertech.cloud/efm/v5/tylerfilingreviewservice.svc
                                                Request Message Definitionbatchdetailrequest
                                                common
                                                Response Message Definitionbatchdetailresponse
                                                common
                                                XML Samples
                                                DescriptionRequestResponse
                                                GetBatchDetailtyler-batchdetailtyler-batchdetailresponse
                                                Inputs
                                                FieldDescription
                                                Batch ID Identifies the batch for which details are requested
                                                /batchdetailrequest:GetBatchDetailMessage/batchdetailrequest:BatchDetailQueryCriteria/tylercommon:BatchIdentification/nc:IdentificationID
                                                Include Details Boolean to indicate whether to return envelope details
                                                /batchdetailrequest:GetBatchDetailMessage/batchdetailrequest:BatchDetailQueryCriteria/batchdetailrequest:IncludeEnvelopeDetailsIndicator
                                                Pagination Provides the ability to receive a paginated subset of envelopes in the batch. The EFM enforces a maximum PageSize of 100
                                                /batchdetailrequest:GetBatchDetailMessage/batchdetailrequest:BatchDetailQueryCriteria/tylercommon:PagingAugmentation/tylercommon:PageIndex
                                                /batchdetailrequest:GetBatchDetailMessage/batchdetailrequest:BatchDetailQueryCriteria/tylercommon:PagingAugmentation/tylercommon:PageSize
                                                Outputs
                                                FieldDescription
                                                Pagination Details Provides details about the current page of results
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:PagingAugmentation/tylercommon:TotalResults
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:PagingAugmentation/tylercommon:PageIndex
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:PagingAugmentation/tylercommon:PageSize
                                                EFSP Batch ID The batch identifier provided by the EFSP
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentFileControlID
                                                EFM Batch ID The EFM's batch identifier will be provided in the IdentificationID element when IdentificationCategoryDescriptionText is BATCHID
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentIdentification/nc:IdentificationID
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                                Batch Type The batch type will be provided in the IdentificationID element when IdentificationCategoryDescriptionText is BATCH_TYPE
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentIdentification/nc:IdentificationID
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                                Batch Size The batch size will be provided in the IdentificationID element when IdentificationCategoryDescriptionText is BATCH_SIZE
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentIdentification/nc:IdentificationID
                                                /batchdetailresponse:GetBatchDetailResponseMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                                Batch Status Current status of the batch. See the GetBatchList API for possible values.
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:BatchStatus/tylercommon:BatchStatusCode
                                                Envelope Repeated for each envelope in the batch subject to pagination constraints. Sorted by ascending sequence number within the batch
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope
                                                Sequence Sequence number within the batch
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:BatchSequence
                                                Envelope Number The envelope number
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:EnvelopeIdentification/nc:IdentificationID
                                                Filing Repeated for each filing in the current envelope
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing
                                                Order The order of the document in the envelope. This information is provided in two separate elements, but preserved to maintain backward compatibility
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentFileControlID
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentSequenceID
                                                Filing Submission Date/Time Date/Time the filing was submitted
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentFiledDate/nc:DateTime
                                                Filing ID The EFM identifier for the filing
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentIdentification/nc:IdentificationID
                                                Submitter Name The full name of the submitter
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentSubmitter/nc:EntityPerson/nc:PersonName/nc:PersonFullName
                                                Submitter ID The EFM identifier for the submitter
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentSubmitter/nc:EntityPerson/nc:PersonOtherIdentification/nc:IdentificationID
                                                Document The document
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                                Filing Component The FilingComponent code
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                                Filename Name of the file submitted by the filer
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                                URL URL by which the document can be downloaded
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryID
                                                MIME Type The document's MIME type
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryFormatText
                                                URL A URL whereby the document may be downloaded
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                                Size Document size in bytes
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                                Document Type The Document Type code
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                                Filing Code The Filing code
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:Filing/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
                                                Case Case information regarding the filing
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case
                                                Court Location The court location associated with the case
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                Case Category The Case Category code
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                                Case Party A case party
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty
                                                Person or Organization A case party is either a person or an organization
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization
                                                Case Party Name The name of the case party
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization/nc:OrganizationName
                                                Party Type The Party Type code
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:CaseParticipantRoleCode
                                                Address
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationStreet/nc:StreetFullText
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationCityName
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationState/nc:LocationStateName
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactMailingAddress/nc:LocationPostalCode
                                                Case ID The EFM's case identifier.
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                                Case Type The Case Type code
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                                Case Number The court case number
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                                Batch Submission Date/Time Timestamp the batch was created (via the first envelope of the batch)
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/nc:Case/tylercommon:CaseAugmentation/tylercommon:FiledDate/nc:DateTime
                                                Total Fees Total fees for the batch
                                                /batchdetailresponse:GetBatchDetailResponseMessage/tylercommon:Envelope/tylercommon:TotalFees/nc:Amount



                                                Tyler Extension: Filing Assembly MDE Service

                                                The Tyler Extension Filing Assembly MDE Service contains APIs that Tyler has added to provide additional capabilities beyond what is defined within the ECF MDE.
                                                  Details of the Tyler Extension Filing Assembly MDE Service APIs are provided below.

                                                  NotifyBatchComplete

                                                  The EFM calls NotifyBatchComplete to notify the EFSP when a batch of filings has completed clerk review. The EFM will not call NotifyFilingReviewComplete for envelopes that belong to a batch.

                                                  This API only applies to batch filing (available in limited jurisdictions).

                                                  Version2022.0
                                                  RequiredConditional functionality, subject to business requirements
                                                  Accessible ToEFM initiates this call therefore no user context
                                                  ServiceTylerFilingAssemblyMDEService
                                                  Sample URLhttps://court.tylertech.cloud/efm/v5/tylerfilingassemblyservice.svc
                                                  Request Message Definitionbatchcallback
                                                  Response Message Definitioncbrn
                                                  XML Samples
                                                  DescriptionRequestResponse
                                                  NotifyBatchComplete - Acceptedtyler-notifybatchcomplete-acceptedtyler-messagestatus
                                                  NotifyBatchComplete - Returnedtyler-notifybatchcomplete-returnedtyler-messagestatus
                                                  Inputs
                                                  FieldDescription
                                                  Status Date Date/time of the batch status
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:BatchStatus/nc:StatusDate/nc:DateTime
                                                  Batch Status Current status of the batch. See the GetBatchList API for possible values
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:BatchStatus/tylercommon:BatchStatusCode
                                                  EFSP ID The identifier assigned to the batch by the EFSP
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:BatchIdentification/nc:IdentificationID
                                                  EFM ID The identifier assigned to the batch by the EFM
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:BatchIdentification/tylercommon:BatchID
                                                  Number of Envelopes The number of envelopes in the batch
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:BatchSize
                                                  Start/End The start & end date/time for the hearing that was scheduled for this batch
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:HearingSchedule/tylercommon:CourtSchedule/tylercommon:ScheduleDayStartTime/nc:DateTime
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:HearingSchedule/tylercommon:CourtSchedule/tylercommon:ScheduleDayEndTime/nc:DateTime
                                                  Court Room The courtroom for the hearing
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:HearingSchedule/tylercommon:CourtRoom
                                                  Envelope Repeats for each envelope within the batch
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope
                                                  Sequence Sequence number of the envelope within the batch
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:BatchSequence
                                                  Envelope Number The current envelope number
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:EnvelopeIdentification/nc:IdentificationID
                                                  Filing ID The EFM identifier for the filing
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentIdentification/nc:IdentificationID
                                                  Document The document associated with the filing
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                                  Order Order of the filing within the envelope
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/nc:DocumentSequenceID
                                                  Filing Component The filing component code for the document
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                                  Document Type The document type code for the document
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                                  File Name The file name
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                                  Document Version ID The EFM identifier for this specific version of the document.
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryID
                                                  Description A description of the document
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                                  MIME Type The MIME type of the document
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryFormatText
                                                  URL The URL whereby the document may be downloaded
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                                  Size The size of the file in bytes
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/tylercommon:Filing/tylercommon:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                                  Case Category The Case Category code of the case
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                                  Case ID EFM identifier for the case
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                                  Case Type The Case Type code of the case
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                                  Case Number The court case number
                                                  /batchcallback:NotifyBatchCompleteMessage/tylercommon:Envelope/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                                  Outputs
                                                  FieldDescription
                                                  No Outputs



                                                  NotifyServiceComplete

                                                  NotifyServiceComplete is an optional API that an EFSP can implement in order to receive notification when one of the EFSP's customers has been served. Tyler must enable this API on a per EFSP per site basis.

                                                  An EFSP customer is defined as any registered user who has submitted a filing through the EFSP. Since registered users are separate from service contacts, this capability depends upon the correlation of a registered user and a service contact record. The EFM establishes this correlation when the email address of a user account matches the email address of a service contact.

                                                  Version2022.0
                                                  RequiredConditional functionality, subject to business requirements
                                                  Accessible ToEFM initiates this call therefore no user context
                                                  ServiceTylerFilingAssemblyMDEService
                                                  Sample URLhttps://court.tylertech.cloud/efm/v5/tylerfilingassemblyservice.svc
                                                  Request Message DefinitionServiceCallback
                                                  Response Message Definitioncbrn
                                                  XML Samples
                                                  DescriptionRequestResponse
                                                  NotifyServiceCompletetyler-notifyservicecompletetyler-messagestatus
                                                  Inputs
                                                  FieldDescription
                                                  Court Location The court location
                                                  /servicecallback:NotifyServiceCompleteMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                  Filing Status The status of the filing
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:FilingStatus/ecf:FilingReviewStatusCode
                                                  Additional Documents Any additional documents that were provided
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview
                                                  Additional Document ConnectedDocumentReview represents any additional documents assocated to a filing. Use PrimaryDocument to reference to associate the document to the appropriate LeadDocumentReview. ConnectedDocumentReview may be repeated to represent multiple documents
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/nc:DocumentAssociation/nc:PrimaryDocument
                                                  Filing A filing that was served. May be repeated to reflect each filing in the envelope.
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview
                                                  Filing Description The filer's description of the filing
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentDescriptionText
                                                  Envelope Number The envelope number for the filing
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:DocumentIdentification/nc:IdentificationID
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                                  Filing ID The EFM identifier for the filing
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:DocumentIdentification/nc:IdentificationID
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:DocumentIdentification/nc:IdentificationCategoryDescriptionText
                                                  Order of the filing in the envelope The order of the filing within the envelope
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/nc:DocumentSequenceID
                                                  Document and Document Metadata The DocumentRendition/Attachment structure represents a document - a digital file such as a PDF.
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment
                                                  Filing Component The FilingComponent code or -364 if this is a result of service only
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:FilingComponentCode
                                                  Page Count The number of pages
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:PageCount
                                                  Filename The document filename
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:OriginalFileName
                                                  Is Redacted Indicates whether the document has been redacted
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/tylercommon:AttachmentAugmentation/tylercommon:IsRedactedIndicator
                                                  Document Description The filer's description of the document
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryDescriptionText
                                                  MIME Type The MIME type of the document
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryFormatText
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryFormatText
                                                  URL The URL whereby the document may be downloaded Documents are available for download for a limited timeframe per Tyler arrangements with the court. If e-service is configured to occur after clerk review, these documents will be stamped; otherwise, they will not be stamped.


                                                  NOTE: Please do not download the documents synchronously within the NotifyServiceComplete operation.
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinaryURI

                                                  Size The size of the document in bytes
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment/nc:BinarySizeValue
                                                  Document Type The Document Type code
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ConnectedDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentTypeCode
                                                  Filing Code The Filing code If the e-service accompanies a filing with the court, this element contains the filing code. If e-service only, this element contains the value "SERVICE ONLY"
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
                                                  Judge Name The judge's name
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:Case/j:CaseAugmentation/j:CaseJudge/nc:RoleOfPerson/nc:PersonName/nc:PersonFullName
                                                  Case ID EFM identifier for the case
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                                  Case Number The court case number
                                                  /servicecallback:NotifyServiceCompleteMessage/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                                  Recipient ID Unique EFM identifier for the e-service recipient
                                                  /servicecallback:NotifyServiceCompleteMessage/ecf:ElectronicServiceInformation/ecf:ServiceRecipientID/nc:IdentificationID
                                                  Service Date/Time Date/Time when the e-service took place
                                                  /servicecallback:NotifyServiceCompleteMessage/tylercommon:ServiceDate/nc:DateTime
                                                  Filer Name The submitter's name, if available
                                                  /servicecallback:NotifyServiceCompleteMessage/tylercommon:SubmitterInformation/tylercommon:SubmitterName
                                                  Filer Firm Name The submitter's firm name, if available
                                                  /servicecallback:NotifyServiceCompleteMessage/tylercommon:SubmitterInformation/tylercommon:SubmitterFirmName
                                                  Recipient Name The recipient's name, if available
                                                  /servicecallback:NotifyServiceCompleteMessage/tylercommon:RecipientInformation/tylercommon:RecipientName
                                                  Recipient Firm Name The recipient's firm name, if available
                                                  /servicecallback:NotifyServiceCompleteMessage/tylercommon:RecipientInformation/tylercommon:RecipientFirmName
                                                  Outputs
                                                  FieldDescription
                                                  No Outputs



                                                  NotifyEvent

                                                  NotifyEvent is an optional API that an EFSP can implement in order to receive notification of specific events that occur within the EFM. Tyler must enable this API on a per EFSP per site basis.

                                                  The request message utilizes a variable number of EventVariable elements, each of which denote a key/value pair. The particular key/value pairs vary according to the context of the notification.

                                                  Version2022.0
                                                  RequiredCore functionality
                                                  Accessible ToEFM initiates this call therefore no user context
                                                  ServiceFilingAssemblyMDEService
                                                  Sample URLhttps://court.tylertech.cloud/efm/v5/filingassemblyservice.svc
                                                  Request Message Definitionnotifyevent
                                                  common
                                                  Response Message Definitioncbrn
                                                  XML Samples
                                                  DescriptionRequestResponse
                                                  NotifyEvent - User Activationnotifyeventrequest-useractivationtyler-messagestatus
                                                  NotifyEvent - Password Resetnotifyeventrequest-passwordresettyler-messagestatus
                                                  NotifyEvent - Service Contact Removalnotifyeventrequest-servicecontactremovaltyler-messagestatus
                                                  NotifyEvent - Service Undeliverablenotifyeventrequest-serviceundeliverabletyler-messagestatus
                                                  Inputs
                                                  FieldDescription
                                                  EventTypeCode A code that defines the context of the notification. See the information below for definitions for each notification type
                                                  /eventcallback:NotifyEventMessage/eventcallback:EventTypeCode
                                                  EventKey An event key applicable to the event type code that triggered the notification
                                                  /eventcallback:NotifyEventMessage/eventcallback:Event/eventcallback:EventVariable/eventcallback:EventKey
                                                  EventValue The value that corresponds to the event key
                                                  /eventcallback:NotifyEventMessage/eventcallback:Event/eventcallback:EventVariable/eventcallback:EventValue
                                                  EventTypeCode=UserActivation indicates that the EFM has sent a user activation email. The call will be sent to the EFSP thru which the user registration took place
                                                  EventKey EventValue
                                                  UserID The EFM's unique identifier for the user
                                                  Email The user's email address
                                                  ActivationLink The URL for activating the user account
                                                  EventTypeCode=PasswordReset indicates that the EFM has sent a password reset email The call will be sent to the EFSP thru which the password reset took place
                                                  EventKey EventValue
                                                  UserID The EFM's unique identifier for the user
                                                  Email The user's email address
                                                  PasswordResetLink The URL for activating the user account
                                                  EventTypeCode=ServiceContactRemoval indicates that a service contact has been detached from a case

                                                  NOTE: This notification is only sent when:

                                                  • SendServiceContactRemovedNotifications is visible for the case's court location
                                                  • The email address associated to the service contact is also associated to a user
                                                  • The user has submitted at least one filing via the EFSP
                                                  • The EFSP is configured within the EFM as having the ability to receive event notifications
                                                  EventKey EventValue
                                                  ServiceContactID The EFM's unique identifier for the service contact
                                                  Email The service contact's email address
                                                  CaseNumber The court case number from which the service contact was removed
                                                  CaseTrackingID The EFM's unique identifier for the case
                                                  RemovedOn The timestamp when the removal occurred
                                                  RemovedByName The name of the person who removed the service contact
                                                  RemovedByEmail The email of the person who removed the service contact
                                                  EventTypeCode=ServiceUndeliverable indicates that the EFM was unable to complete service. The call will be sent to the EFSP thru which the request for service was received
                                                  EventKey EventValue
                                                  ServiceContactID The EFM identifier for the service contact
                                                  Email The email address of the service contact
                                                  CaseNumber The court case number for the case
                                                  CaseTrackingID The EFM identifier for the case
                                                  FilingID The EFM identifier for the filing
                                                  Outputs
                                                  FieldDescription
                                                  No Outputs



                                                  Tyler Extension: Court Record MDE Service

                                                  The Tyler Extension Court Record MDE Service contains APIs that Tyler has added to provide additional capabilities beyond what is defined within the ECF MDE.
                                                    Details of the Tyler Extension Court Record MDE Service APIs are provided below.

                                                    GetServiceCaseList

                                                    GetServiceCaseList retrieves a list of cases to which a service contact has been attached.
                                                    Version2022.0
                                                    RequiredCore functionality
                                                    Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                                                    User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                    ServiceTylerCourtRecordMDEService
                                                    Sample URLhttps://court.tylertech.cloud/efm/v5/tylercourtrecordservice.svc
                                                    Request Message Definitionservicecaselist
                                                    Response Message Definitionservicecaselistresponse
                                                    XML Samples
                                                    DescriptionRequestResponse
                                                    GetServiceCaseListtyler-servicecaselistrequesttyler-servicecaselistresponse
                                                    Inputs
                                                    FieldDescription
                                                    Service Contact ID Unique EFM identifier for the service contact
                                                    /servicecaselist:GetServiceCaseListMessage/ecf:ServiceRecipientID/nc:IdentificationID
                                                    Outputs
                                                    FieldDescription
                                                    Case Zero, one, or many cases returned.
                                                    /servicecaselistresponse:GetServiceCaseListResponseMessage/nc:Case
                                                    Case Title The style or title of the case
                                                    /servicecaselistresponse:GetServiceCaseListResponseMessage/nc:Case/nc:CaseTitleText
                                                    Case ID Unique EFM identifier for the case
                                                    /servicecaselistresponse:GetServiceCaseListResponseMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                                    Case Number The court's case number for the case
                                                    /servicecaselistresponse:GetServiceCaseListResponseMessage/nc:Case/ecf:CaseAugmentation/j:CaseNumberText
                                                    Court Location The court location identifier for the case
                                                    /servicecaselistresponse:GetServiceCaseListResponseMessage/nc:Case/j:CaseAugmentation/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID



                                                    GetServiceInformationHistory

                                                    GetServiceInformationHistory retrieves a history of service contacts that have been attached to the case or the case parties.
                                                    Version2022.0
                                                    RequiredConditional functionality, subject to business requirements
                                                    Accessible ToAny registered user. If CSM is enabled, requires the ViewService resource.
                                                    User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                    ServiceTylerCourtRecordMDEService
                                                    Sample URLhttps://court.tylertech.cloud/efm/v5/tylercourtrecordservice.svc
                                                    Request Message Definitionserviceinformationhistory
                                                    Response Message Definitionserviceinformationhistoryresponse
                                                    XML Samples
                                                    DescriptionRequestResponse
                                                    GetServiceInformationHistorytyler-serviceinformationhistorytyler-serviceinformationhistoryresponse
                                                    Inputs
                                                    FieldDescription
                                                    Court Location The Court Location code identifier for the case
                                                    /serviceinformationhist:GetServiceInformationHistoryMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                    Case ID Unique EFM identifier for the case
                                                    /serviceinformationhist:GetServiceInformationHistoryMessage/ecf:CaseTrackingID/nc:IdentificationID
                                                    Outputs
                                                    FieldDescription
                                                    Case ID EFM case identifier
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/ecf:CaseTrackingID/nc:IdentificationID
                                                    Service Recipient Identifies a service contact that is, or once was, attached to the case. This element will be repeated for each service contact that has been attached to the case.
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient
                                                    Name The first and last name of the service contact
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/nc:EntityPerson/nc:PersonName/nc:PersonGivenName
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/nc:EntityPerson/nc:PersonName/nc:PersonSurName
                                                    Email The email address for the service contact

                                                    A second ContactEmailID reflects the administrative copy email.
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/nc:EntityPerson/ecf:PersonAugmentation/nc:ContactInformation/nc:ContactEmailID

                                                    Service Contact ID The unique EFM identifier for the service recipient
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/tylercommon:ServiceContactID/nc:IdentificationID
                                                    Firm Name If the service contact belongs to a firm, this provides the firm name. Otherwise, it will indicate "Individual" which indicates that the service contact belongs to an individual user account.
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/tylercommon:FirmName
                                                    Action A reverse chronological list of actions (Attach, Detach, Delete) taken for this service contact on this case, along with the corresponding date/time stamp
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/tylercommon:Action
                                                    /serviceinformationhist:GetServiceInformationHistoryResponseMessage/tylercommon:ServiceRecipient/tylercommon:Action/tylercommon:ActionTimestamp/nc:DateTime



                                                    Tyler Extension: Court Scheduling MDE Service

                                                    The Tyler Extension Court Scheduling MDE Service contains APIs that Tyler has added to provide additional capabilities beyond what is defined within the ECF MDE.
                                                      Details of the Tyler Extension Court Scheduliing MDE Service APIs are provided below.

                                                      GetReturnDate

                                                      NOTE: This API is currently restricted for use solely within the eFileIL market.
                                                      GetReturnDate calculates the first applicable return date based upon statute and/or local court rules. The return date pertains to the envelope, not the individual filings in the envelope. This API is only available for court locations where AllowReturnDate = True
                                                      Version2022.0
                                                      RequiredConditional functionality, subject to business requirements
                                                      Accessible ToAny registered user. If CSM is enabled, requires the ScheduleHearing resource.
                                                      User CredentialsUserNameHeader required in SOAP header with UserName (email) & Password (hash)
                                                      ServiceCourtSchedulingMDEService
                                                      Sample URLhttps://court.tylertech.cloud/efm/v5/tylercourtschedulingservice.svc
                                                      Request Message Definitionreturndaterequest
                                                      Response Message Definitionreturndateresponse
                                                      XML Samples
                                                      DescriptionRequestResponse
                                                      GetReturnDate - Initial Filingtyler-returndaterequest-efsp-initialtyler-returndateresponse
                                                      GetReturnDate - Subsequent Filingtyler-returndaterequest-efsp-subsequenttyler-returndateresponse
                                                      Inputs
                                                      FieldDescription
                                                      Date/Time Envelope Submitted The date and time that the envelope was submitted
                                                      /returndate:ReturnDateMessage/nc:DocumentFiledDate/nc:DateTime
                                                      /returndate:ReturnDateMessage/nc:DocumentPostDate/nc:DateTime
                                                      Court Location The Court Location code for the case being filed or filed into
                                                      /returndate:ReturnDateMessage/j:CaseCourt/nc:OrganizationIdentification/nc:IdentificationID
                                                      Filing Code The Filing code the filer intends to submit
                                                      /returndate:ReturnDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:FilingCode
                                                      Motion Code The Motion Type code filer intends to submit
                                                      /returndate:ReturnDateMessage/nc:Case/j:CaseAugmentation/j:CaseCourtEvent/tylercommon:CourtEventAugmentation/tylercommon:MotionTypeCode
                                                      Attorney Repeat this element as necessary to reflect attorneys relevant to this filing. IdentificationID provides the EFM identifier for an attorney within the filer's firm. Refer to the Attorney Management APIs for more information.
                                                      CaseRepresentedParty associates the attorney to the party being represented and can be repeated if representing multiple parties.
                                                      /returndate:ReturnDateMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/nc:RoleOfPerson/ecf:PersonAugmentation/ecf:ParticipantID/nc:IdentificationID
                                                      /returndate:ReturnDateMessage/nc:Case/j:CaseAugmentation/j:CaseOfficial/ecf:CaseOfficialAugmentation/ecf:CaseRepresentedParty
                                                      Case Category The Case Category code of the case
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseCategoryCode
                                                      Case Party Repeat this element for each case party relevant to this filing. Include any new case parties as well as any existing party for which an attorney is being added.
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty
                                                      Person or Organization EntityPerson represents a case participant that is either an individual or an attorney. EntityOrganization represents a case participant that is an organization. The s:id attribute establishes an identifier whereby the case party can be referenced elsewhere within the message.
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityOrganization
                                                      Case Party Role A valid PartyType code to indicate the case party's role role within the case.
                                                      Self Represented A boolean to indicate whether this is a self-represented litigant
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseParty/nc:EntityPerson/ecf:PersonAugmentation/ecf:CasePartySelfRepresentationIndicator
                                                      Case ID The EFM's unique ID for the case. Only applicable for subsequent filings
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTrackingID/nc:IdentificationID
                                                      Case Type The Case Type code of the case
                                                      /returndate:ReturnDateMessage/nc:Case/ecf:CaseAugmentation/ecf:CaseTypeCode
                                                      Out of State Flag to represent whether the filing includes out of state service
                                                      /returndate:ReturnDateMessage/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:OutOfStateIndicator
                                                      Return Date The requested return date for the envelope's filings
                                                      /returndate:ReturnDateMessage/nc:Case/tylercommon:SchedulingAugmentation/tylercommon:ReturnDate/nc:Date
                                                      Filing Party Reference to the filing party
                                                      /returndate:ReturnDateMessage/tylercommon:ReturnDateMessageAugmentation/tylercommon:FilingParty/tylercommon:PartyReference
                                                      Filing Attorney Reference to the filing attorney
                                                      /returndate:ReturnDateMessage/tylercommon:ReturnDateMessageAugmentation/tylercommon:FilingAttorney/tylercommon:AttorneyReference
                                                      Cross Reference Number ReferenceTypeCode must contain a valid Cross Reference Code. ReferenceNumber should contain the cross reference number
                                                      /returndate:ReturnDateMessage/tylercommon:ReturnDateMessageAugmentation/tylercommon:CrossReference/tylercommon:ReferenceNumber
                                                      /returndate:ReturnDateMessage/tylercommon:ReturnDateMessageAugmentation/tylercommon:CrossReference/tylercommon:ReferenceTypeCode
                                                      AmountInControversy Ad Damnum (damage amount) being sought
                                                      /returndate:ReturnDateMessage/nc:Case/civil:CaseAugmentation/civil:AmountInControversy/nc:Amount
                                                      Outputs
                                                      FieldDescription
                                                      Return Date The return date necessary to meet statutory and/or court requirements
                                                      /returnresponse:ReturnDateResponseMessage/returnresponse:ReturnDate/nc:Date



                                                      Revised on 07/31/2025
                                                      © 2025 Tyler Technologies. All rights reserved.
                                                      Tyler Technologies