4-Attachment 4 - CSD SOP WebService Design.docx

ATTACHMENT 4

Attorney General of Texas Child Support Division

Software Design Document (SDD) for Service of Process Web Service

Table of Contents

Scope The Service of Process application serves as an integration point between the State of Texas Office of the Attorney General and vendors who are contracted to perform service of process. This application uses XML-based standards to perform this integration, and to communicate historical data, and new data collected by vendors and the state. As this exchange occurs, the exchanged data will move through several states during the lifecycle of a service of process. Through this exchange of information, the Service of Process application will be able to gather data in regard to individuals whereabouts, and determine proper determination for vendors contracted to perform this service of process. The standard protocol for the messaging will be over simple object access protocol, using typical TCP/IP wire standards, the communication will occur using the OCEAN 1.1 specification for web services, and will adopt the document/literal message type as defined by standards. The standard for the XML based communication will be using the federal NIEM standard for data communication. The Texas extensions for NIEM documents IEPD20, and IEPD21 will provide the basis for this communication. The application will utilize static text as help services.

Assumptions

1. Vendor communication exchange will happen in a document literal format.

2. The transport protocol over https will provide encryption of the message exchange.

3. The vendor will implement web services in a fashion as described in this document Background The primary means of information exchange between the OAG Child Support portal and the Service of Process vendor is through a pair of architected XML exchanges. In this document outgoing will refer to messages being sent from the OAG to the vendor; incoming will refer to messages being sent to the OAG from the vendor. The XML document types are known as:

· DocumentServiceRequest (IEPD20): outgoing document containing all the parameters needed by the vendor to initiate (and hopefully complete) a process service request.

· ServiceResultsNotification (IEPD21): incoming XML document containing status information representing either completion of a prior IEPD20 or a request for further information needed to complete a prior IEPD20.

Figure 1: Message Flow

OAG

Web Service

SoP Vendor IEPD21 + optional PDFs IEPD20-errors

IEPD20

IEPD21-errors

· Figure 1 is a high level depiction of the overall message flow between OAG and SoP independent of transport technology.

· Services over SOAP – Each transaction/message between parties is communicated over HTTP as a SOAP message. Web Services will be written which vendor will consume to get requested XML file (IEPD20) and send response XML file (IEPD21).

A. Web Services Modules

A.1.1 – Service of Process Web Service Interface The Service Of Process web service will expose multiple SOAP operations for communication between the application and vendor applications. This service will communicate XML based documents between the vendor of a service of process and the Service of Process application. These operations will communicate several things to the vendor such as new or historical address locations the Service of Process application has collected, the state of a service of process request, and service results notification regarding the servee.

Initially, the vendor calls the documentStatusRequest() operation, which will supply the vendor with necessary data elements to identify the service of process. Upon receiving a document from this operation invocation (IEPD20), the vendor will perform, in the field, a service attempt to attempt to find the individual as described in the document. At this point, the vendor will call the status update transaction operation of the Service of Process web service. The vendor will communicate an IEPD21 indicating whether they need more information regarding the individual, or whether they have closed the document service request. When the vendor has completed their tasks, the vendor will call the requestImages operation with a pdf describing their attempts.

Status Update Transaction Operation IEPD21 statusUpdateTransaction(String serviceRequestId) The state will receive an IEPD21 document indicating possible other addresses that have been collected by the Service of Process application for a particular servee. This document may include data regarding request status, new addresses, surveillance info, and new locate of a servee.

This operation will not return all historical data regarding a servee, and will only return two new address locations per invocation.

Receive Images Transaction Operation SopServiceResponse requestImages(ImageRequestType payload) The consuming vendor will send an ImageRequestType element payload in SOAP, which will consist of a required service request ID, a required image in base64 string format, and an optional iepd20

A.1.2 – Service of Process Vendor Invocation Upon submitting vehicle and address information, the Service Of Process application will take data collected by the application and transform the data into XML. This XML will be stored in DB2 as a CLOB in the “T_SOP_RQST_IEPD20” table. SOAP operations will be provided to the vendor to supply the vendor with this data. Upon invocation of the service, the service will retrieve the XML data and relay the data to the vendor in the form of an IEPD20 document. The Service Of Process application will transform the DataTransferObject entity in the application to a DocumentServiceRequestDocument Object, through the use of the SopServiceFactory. This transformation will be using generated object types constructed using the XMLBeans framework, and base this generation on the NIEM schemas. This generation will occur through the one time use of an ANT (please see XMLBeans Ant Task Example) task that is packaged with the XMLBeans framework. These generated classes will be included in a .jar file and checked into the project.

The DocumentServiceRequestDocument object will be fed into an output stream that will inevitably be formed into a well-qualified SOAP message.

A.1.3 – Service Of Process Interfaces

SopServiceService.java us.tx.state.oag.cs.sop.services.interfaces

A.1.4 – Web Service Security – Identification, authentication, and authorization Many Web service providers require that the service requestor provide information that identifies its origin or its owner before accessing the service. This is commonly referred to as making a claim. WS-Security has standardized header blocks, known as tokens, that can be used to store this information. The Web service consuming the request first attempts to authenticate the token; that is, find out if the requestor is a valid user in the system. Next, the Web service may attempt to see if the user associated with the request has authority to do what he or she is attempting to do. This is referred to as authorization.

Authentication: Username Profile Token 1.0 over SSL mechanism is used for authentication. The vendor calling the service authenticates themselves using a username/password combination as part of a token placed in a WS-Security header inside the SOAP: envelope header element. The User account will be created using Portal Administration. The account and password will be stored in the LDAP server used by the Portal environment. Upon incoming request, the user-ID/password will be validated against the one stored in LDAP and a SOAP fault thrown if the ID/password does not match.

Issues: When an invalid user-ID/password is detected, a SOAP fault is thrown by the global security handler which contains sensitive information about the user-ID/password error thrown. At this time, the SOAP fault cannot be captured and handled to display a generic message. The IBM solution at this time is to create a custom JAAS login module which can trap the LDAP error directly and display an appropriate message.

Authorization: The username token mechanism provides the ability to validate that the service is being called by a valid user. But that is not sufficient since an active LDAP user can make a service call. To validate that only an authorized vendor can make the service call, the web service user-ID for the vendor is going to be stored in vendor table. If the web service user-ID is associated with a vendor with an active status, the call is allowed. Otherwise, a SOAP fault is thrown to indicate the unauthorized access. The table used to store the SOP vendor record with the user-ID is T_VEND.

Security Web Services level security will be handled using public certificates on web server and user name tokens and SOAP fault codes will be communicated accordingly to the vendor in event of failure.

Other Service of Process portal application: In the event of database errors and failures appropriate messages will be displayed on portal pages.

In the event of failure with the vendor’s IT staff some of the approaches planned to handle communication between vendor and OAG are as follows:

· Security for the vendor staff is handled using public certificates on web server and user name tokens. If there are application and business validation failures appropriate SOAP faults are generated and communicated back to the vendor to take appropriate actions.

· In the event of network failures verbal and email communication should occur to between OAG and vendor staff .

IEPD20 Critical Data Elements

IEPD21 Critical Data Elements

Attachment 4 SoP WebService Design document Page 149 of 149 image1.png image2.emf

Microsoft_Visio_2003-2010_Drawing.vsd

<Process Name>�

<Function>�

Person 1

Document Service Request

Sop WebService

IEPD20

UpdateStatusTransaction (IEPD21)

ImageRequest(Binary PDF)

Vendor image3.emf

IEPD20 Critical Data Elements Updated.xlsx Sheet1

Key Field Name Description New Service Request 20 Cancel Request 20 Send New Locate 20 No New Locate 20 Miscellaneous updates 20 Comments

20.1 County of filing (name) County where documents in the service packet were filed R

20.3 Court of filing (number) Court (number) where documents in the service packet were filed, and where hearing will take place R

20.4 Intentionally left blank

20.5 Hearing date/time Date and time when servee's hearing is scheduled to occur. O

20.6 Method Requested Method of service to be used by process server to deliver service packet. This also determines the invoice rate. Examples: Regular, Same Day, Rush, Guaranteed, International, Locate & Serve, Certified Mail R

20.7 Intentionally left blank

20.8 OAG additional comments/special instructions Additional information such as possible service times, roommates, etc.

If Family Violence is associated with the servee, this will contain the text "Address being withheld due to allegations of family violence." O O O Any comments entered by OAG staff will be reported to the vendor on this field. For "Miscellaneous Updates" transaction type, OAG could send vendor new comments without the presence of a new address.

US-61 Exchange Information with EZM

20.11 Intentionally left blank

20.12 OAG Office address line 1 Line 1 of OAG field office of person requesting service R

OAG Office address line 2 Line 2 of OAG field office of person requesting service O

OAG Office address line 3 Line 3 of OAG field office of person requesting service O

20.13 OAG Office city City of OAG field office of person requesting service R

20.14 OAG Office fax Fax number of OAG field office of person requesting service O

20.19 OAG Office number/name OAG assigned number and name of OAG field office of person requesting service R

20.16 OAG Office state State of OAG field office of person requesting service R

20.17 OAG Office phone General phone number of OAG field office of person requesting service R

20.18 OAG Office zip Zip code of OAG field office of person requesting service R

20.19 Intentionally left blank

20.20 OAG contact 1 name Name of first person to contact for information about a service request R

20.21 OAG contact 1 phone number Phone number of first person to contact for information about a service request R

20.22 OAG contact 1 email Email address of first person to contact for information about a service request R

20.23 OAG contact 2 name Name of second person to contact for information about a service request R

20.24 OAG contact 2 phone number Phone number of second person to contact for information about a service request R

20.25 OAG contact 2 email Email address of second person to contact for information about a service request R

20.26 Packet received date/time

20.27 Packet delivery to vendor method Indicates how process server will obtain service packet (e.g. Pick up at office, mail to vendor, pick up at District Clerk) R

20.28 Pleading Title of main document for the pleading. There may be multiple pleadings on a service request if more than one are being served together in one packet. If multiple titles, they will be concatenated into one field. R

20.28.1 Pleading Date/Time Filing date on the service packet (date documents filed with the court) R

20.27 Servee age or age range XML -PersonAgeMeasure

Age, or estimated age, of the servee O

20.28 Servee alias name Alias name of the servee O

20.28.1 Intentionally left blank

20.29 Servee date of birth Date of birth of the servee O

20.30 Servee eye color Eye color of the servee O

20.32 Servee hair color Hair color of the servee O

20.33 Servee height Height (in feet and inches) of the servee O

20.36 Servee phone number 1 Phone number of servee or contact (1 field containing country code, area code, phone number; separate field for extension) O

20.36.1 Servee phone 1 extension Phone extension of servee or contact

20.36.2 Servee phone type 1 Type or owner of phone number: cell, home, work, friend, relative, etc. O

20.37 Servee phone number 2 Phone number of servee or contact (1 field containing country code, area code, phone number; separate field for extension) O

20.37.1 Servee phone 2 extension Phone extension of servee or contact

20.37.2 Servee phone type 2 Type or owner of phone number: cell, home, work, friend, relative, etc. O

20.38 Servee phone number 3 Phone number of servee or contact (1 field containing country code, area code, phone number; separate field for extension) O

20.38.1 Servee phone 3 extension Phone extension of servee or contact

20.38.2 Servee phone type 3 Type or owner of phone number: cell, home, work, friend, relative, etc. O

20.39 Servee race Race of servee O

20.40 Servee sex (gender) Gender of servee O

20.41 Servee special identifying marks Identifying marks or accessories (e.g., tattoos, scars, facial hair, glasses, cane, prosthetics, etc.) O

20.42 Servee SSN Social Security number of servee O

20.43 Servee state ID or driver's license number Driver's license or other state identifier number O

20.43.1 Servee state ID or driver's license number expiration date Date on which the servee's driver's license or other state ID expires O

20.44 Servee state issuing ID (driver's license or other state ID) State which issued the driver's license or other state identifier number O

20.46 Servee Vehicle 1 make Make of servee's vehicle O

20.47 Servee Vehicle 1 model Model of servee's vehicle O

20.48 Servee Vehicle 1 year Year of servee's vehicle O

20.49 Servee Vehicle 1 color Color of servee's vehicle O

20.50 Servee Vehicle 1 license plate License plate number of servee's vehicle O

20.51 Servee Vehicle 1 license plate state State which issued the license plate of servee's vehicle O

20.52 Servee Vehicle 2 make Make of servee's vehicle O

20.53 Servee Vehicle 2 model Model of servee's vehicle O

20.54 Servee Vehicle 2 year Year of servee's vehicle O

20.55 Servee Vehicle 2 color Color of servee's vehicle O

20.56 Servee Vehicle 2 license plate License plate number of servee's vehicle O

20.57 Servee Vehicle 2 license plate state State which issued the license plate of servee's vehicle O

20.58 Servee Vehicle 3 make Make of servee's vehicle O

20.59 Servee Vehicle 3 model Model of servee's vehicle O

20.60 Servee Vehicle 3 year Year of servee's vehicle O

20.61 Servee Vehicle 3 color Color of servee's vehicle O

20.62 Servee Vehicle 3 license plate License plate number of servee's vehicle O

20.63 Servee Vehicle 3 license plate state State which issued the license plate of servee's vehicle O

20.64 Servee weight Weight (in pounds) of servee O

20.65.1 Service address 1 type Type of address (e.g., home, work, service)

This is required if Method Requested requires an address.

This is optional if Method Requested does not require an address. [R]

This is required if Method Requested requires an address.

This is optional if Method Requested does not require an address.

Note: no addresses will be sent if Family Violence is associated with the servee. [R]

Service address 1 line 2 Line 2 of address for service attempts O

Service address 1 line 3 Line 3 of address for service attempts O

20.66 Service address 1 city City of address for service attempts

This is required if Method Requested requires an address.

This is optional if Method Requested does not require an address. [R]

20.67 Service address 1 county County of address for service attempts (for Texas addresses) O

20.68 Service address 1 state / territory State or territory of address for service attempts (for domestic addresses)

This is required if Method Requested requires an address.

This is optional if Method Requested does not require an address. [R]

20.69 Service address 1 province Province of address for service attempts, if address is in Canada or Mexico O

20.70 Service address 1 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O

21.71 Service address 1 country Country of address for service attempts, if foreign address [R]

20.72 Service address 1 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O

20.72.1 Service address 2 type Type of address (e.g., home, work, service) O O O

20.73 Service address 2 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 2 may be sent on a new request; or if only one address is sent on a new request, Address 2 may be on Send New Locate O O O

20.74 Service address 2 line 2 Line 2 of address for service attempts O O O

Service address 2 line 3 Line 3 of address for service attempts O O O

20.75 Service address 2 city City of address for service attempts O O O

20.76 Service address 2 county County of address for service attempts (for Texas addresses) O O O

20.77 Service address 2 state / territory State or territory of address for service attempts O O O

20.78 Service address 2 province Province of address for service attempts, if address is in Canada or Mexico O O O

20.79 Service address 2 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O O

20.80 Service address 2 country Country of address for service attempts, if foreign address O O O

20.75 Service address 2 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O O

Service address 3 type Type of address (e.g., home, work, service) O O

20.76 Service address 3 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 3 may be sent as New Locate either before or after Require New Locate is received O O

Service address 3 line 2 Line 2 of address for service attempts O O

Service address 3 line 3 Line 3 of address for service attempts O O

20.77 Service address 3 city City of address for service attempts O O

20.78 Service address 3 county County of address for service attempts (for Texas addresses) O O

20.79 Service address 3 state / territory State or territory of address for service attempts O O

20.80 Service address 3 province Province of address for service attempts, if address is in Canada or Mexico O O

20.81 Service address 3 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O

20.82 Service address 3 country Country of address for service attempts, if foreign address O O

20.83 Service address 3 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O

Service address 4 type Type of address (e.g., home, work, service) O O

20.84 Service address 4 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 4 may be sent as New Locate either before or after Require New Locate is received O O

Service address 4 line 2 Line 2 of address for service attempts O O

Service address 4 line 3 Line 3 of address for service attempts O O

20.85 Service address 4 city City of address for service attempts O O

20.86 Service address 4 county County of address for service attempts (for Texas addresses) O O

20.87 Service address 4 state / territory State or territory of address for service attempts O O

20.88 Service address 4 province Province of address for service attempts, if address is in Canada or Mexico O O

20.89 Service address 4 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O

20.90 Service address 4 country Country of address for service attempts, if foreign address O O

20.91 Service address 4 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O

20.92 Service address 5 type Type of address (e.g., home, work, service) O O

20.93 Service address 5 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 5 may be sent as New Locate after Require New Locate is received O O

Service address 5 line 2 Line 2 of address for service attempts O O

Service address 5 line 3 Line 3 of address for service attempts O O

20.94 Service address 5 city City of address for service attempts O O

20.95 Service address 5 county County of address for service attempts (for Texas addresses) O O

20.96 Service address 5 state / territory State or territory of address for service attempts O O

20.97 Service address 5 province Province of address for service attempts, if address is in Canada or Mexico O O

20.98 Service address 5 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O

20.99 Service address 5 country Country of address for service attempts, if foreign address O O

20.100 Service address 5 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O

Service address 6 type Type of address (e.g., home, work, service) O O

20.101 Service address 6 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 6 may be sent as New Locate after Require New Locate is received O O

Service address 6 line 2 Line 2 of address for service attempts O O

Service address 6 line 3 Line 3 of address for service attempts O O

20.102 Service address 6 city City of address for service attempts O O

20.103 Service address 6 county County of address for service attempts (for Texas addresses) O O

20.104 Service address 6 state / territory State or territory of address for service attempts O O

20.105 Service address 6 province Province of address for service attempts, if address is in Canada or Mexico O O

20.106 Service address 6 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O

20.107 Service address 6 country Country of address for service attempts, if foreign address O O

20.108 Service address 6 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O

Service address 7 type Type of address (e.g., home, work, service) O O

20.109 Service address 7 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 7 may be sent as New Locate after Require New Locate is received O O

Service address 7 line 2 Line 2 of address for service attempts O O

Service address 7 line 3 Line 3 of address for service attempts O O

20.110 Service address 7 city City of address for service attempts O O

20.111 Service address 7 county County of address for service attempts (for Texas addresses) O O

20.112 Service address 7 state / territory State or territory of address for service attempts O O

20.113 Service address 7 province Province of address for service attempts, if address is in Canada or Mexico O O

20.114 Service address 7 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O

20.115 Service address 7 country Country of address for service attempts, if foreign address O O

20.116 Service address 7 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O

20.117 Service address 8 type Type of address (e.g., home, work, service) O O

20.118 Service address 8 line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) for service attempts

Address 8 may be sent as New Locate after Require New Locate is received O O

Service address 8 line 2 Line 2 of address for service attempts O O

Service address 8 line 3 Line 3 of address for service attempts O O

20.119 Service address 8 city City of address for service attempts O O

20.120 Service address 8 county County of address for service attempts (for Texas addresses) O O

20.121 Service address 8 state / territory State or territory of address for service attempts O O

20.122 Service address 8 province Province of address for service attempts, if address is in Canada or Mexico O O

20.123 Service address 8 region Region of address for service attempts, if foreign address (not in Canada or Mexico) O O

20.124 Service address 8 country Country of address for service attempts, if foreign address O O

20.125 Service address 8 zip / postal code Zip code of address for service attempts; or postal code, if foreign address O O

20.126 Service Request date/time Date and time the service request was made available to the vendor R

20.127 Service Request number OAG-assigned unique service request identifier R R R R R

20.128 Vendor company name Name of SoP vendor R R R R R

20.129 Vendor Id OAG-assigned unique vendor identifier R R R R R

20.130 Document Service Status Type of XML file being sent:

New Document Service Request Cancel Request No New Locate Send New Locate Miscellaneous Updates R R R R R

20.131 Updated Information Indicator For each type of IEPD20, the value is:

New Request = True Cancel Request = False Send New Locate = True No New Locate = False Miscellaneous Updates = True

If False, indicates that vendor should close the request and send an IEPD21 XML "Closed" file. R R R R R

20.132 XML create date/time Date/time XML is created and available for SoP vendor R R R R R

20.133 XML create ID Program ID or user R R R R R

20.134 Cancellation Reason This field captures the cancellation reason for the Service Request.

Valid Values:

- Case is non-suited

- The subject signed a waiver of service

- An order was obtained

- No vendor action taken

- Required public service

- Request submitted in error or with errors

- No new locate information available

- Other

- Legal Path Closure

- Delinquency Closure R US-24 Close open service requests

21.135 Document ID Unique Identifier for the uploaded file. R O O O O US-50 Deliver Uploaded Files to Vendor

10/14 - Removed

20.135 Document Data Binary Base64 file data i.e., binary encoding of data. R O O O O US-50 Deliver Uploaded Files to Vendor

20.136 Document Date Date (YYYY-MM-DD-HH:MM) on which the file was uploaded. R O O O O US-50 Deliver Uploaded Files to Vendor

10/14 - Date format updated to "YYYY-MM-DD-HH:MM" to be consistent with other dates in the XML.

20.137 Document Type and name Document type and File name.

Valid values:

- Citation - <File Name Here>

- Subpoena - <File Name Here>

- Precept - <File Name Here>

- Notice - <File Name Here>

- Identification (ID) sheet - <File Name Here>

- Photo - <File Name Here>

- Other - <File Name Here> R O O O O US-50 Deliver Uploaded Files to Vendor

20.138 Document File format File format.

Valid values:

- PDF

- XLS

- XLSX

- DOC

- DOCX

- JPG

- PNG

- GIF R O O O O US-50 Deliver Uploaded Files to Vendor

20.139 Substitute Service Type Code Only appplicable when service method is Substitute service. Valid values:

- Posted

- Other O 11/10/2021 - US-58 – Substitute Service Type

20.140 Show Cause Order Indicator Indicates if the service request includes a Show Cause order. Valid values: True or False R 11/10/2021 - US-59 – Legal Action with Show Cause Order

IEPD20 XML Elements Page &P of &N

Sheet2

Sheet3 image4.emf

IEPD21 Critical Data Elements Updated.xlsx Sheet1

Key Field Name Description Service Attempt 21 Req New Locate 21 Close request 21 Miscellaneous updates 21 Comments

21.1 Address Served line 1 Line 1 of address where servee was successfully served

Required if Successful Service O

Address Served line 2 Line 2 of address where servee was successfully served O

Address Served line 3 Line 3 of address where servee was successfully served O

21.2 Address Served city City of address where servee was successfully served O

21.3 Address Served county County of address where servee was successfully served (if Texas county) O

21.4 Address Served state / territory State or territory of address where servee was successfully served (if domestic address) O

21.5 Address Served province Province of address where servee was successfully served (If address is in Canada or Mexico) O

21.6 Address Served region Region of address where servee was successfully served

(If foreign address not in Canada or Mexico) O

21.7 Address Served country Country of address where servee was successfully served (if foreign address) O

21.9 Address Served type Type of address where servee was successfully served (e.g., home, work, etc.)

Required if Successful Service O

21.11 XML category Describes the type or purpose of the XML being sent:

Service Attempt; or Request New Locate; or Closed; or Miscellaneous Updates R R R R

21.10 Intentionally left blank

Not Served Reason Code Reason service was not successful (code), if not served O

21.11+F43D14A17:D35A17:F50D14A17:D35A17:H50A17:I50A17:H50A17:H51 Not Served Reason Description Reason service was not successful (text), if not served O

Process Server certification or license # Certification or license # of process server R R R R

21.12 Process Server first name First name of process server assigned to the service request R R R R

21.13 Process Server last name Last name of process server assigned to the service request R R R R

21.14 Process Server phone (cell) Cell phone number of process server assigned to the service request R R R R

21.15 Process Server phone (office) Office phone number of process server assigned to the service request R R R R

21.16 Process Server email address Email address of process server assigned to the service request R R R R

21.17 Process Server fax Fax number of process server assigned to the service request O R R O

21.18 Servee first name First name of the servee R R R R

21.19 Servee last name Last name of the servee R R R R

21.20 Servee middle name Middle name or initial of the servee O O O O

21.21 Servee title / suffix Title or suffix of servee name (e.g., Jr, Sr, III) O O O O

21.22 Service attempt address line 1 Line 1 of street address; or addressee (if address is for an employer, business entity, or attorney) of service attempt O O

Service attempt address line 2 Line 2 of address of service attempt O O

Service attempt address line 3 Line 3 of address of service attempt O O

21.23 Service attempt address city City of address of service attempt O O

21.24 Service attempt address county County of address of service attempt (for Texas addresses) O O

21.25 Service attempt address state / territory State or territory of address of service attempt (if domestic address) O O

21.26 Service attempt address province Province of address of service attempt, if address is in Canada or Mexico O O

21.27 Service attempt address region Region of address of service attempt, if foreign address (not in Canada or Mexico) O O

21.28 Service attempt address country Country of address of service attempt (if foreign address) O O

21.29 Service attempt address zip / postal code Zip code of address of service attempt; or postal code, if foreign address O O

21.30 Service attempt date/time Date and time of service attempt R O

21.31 Service attempt description Process server's comments about service attempt R O

21.32 Intentionally left blank

21.33 Service attempt success indicator Use to be determined R O

21.34 Intentionally left blank

21.35 Service Request date/time Date/time Service Request was made available to the vendor R R R R

21.36 Service Request number OAG-assigned unique service request identifier R R R R

21.37 Service Request tracking ID Vendor assigned unique service request identifier O O O O

Service Request Status Status of Service Request:

If not closed = Pending If closed / served = Served If closed / not served = Not Served R

21.38 SoP provided by Law Enforcement Official indicator Indicates that vendor turned service packet over to public Law Enforcement Official to provide service O

21.39 Substitute Service requested indicator Indicates that Substitute Service was performed and delivery method used. O

21.40 Vendor company name Name of SoP vendor providing service R R R R

21.41 XML create date/time Date/time XML is created R R R R

Intentionally left blank

21.42 Service Method Successful Code Service Method success code

21.43 Service Method Unsuccessful Code Service Method lack of success code

21.44 Transactional status of IEPD21 Transactional status of IEPD 21: -Service Attempt Request New Locate Information Closed Miscellaneous Updates R R R R

21.45 Indication of the final state of service Indication of the final state of service

21.46 Code describing the final state of service Closed - Served Closed - Not Served etc. R

21.49 Not Served reason code

O

21.47 Decription describing the final state of servce Not Served reason description O

21.48 Comments in regards to the final state of service Additional vendor comments/notifications O

21.49 Packet Status Status of the packets which were delivered to the vendor. Valid Values:

Complete Incomplete O O O O US-12 Communication - Packet Received and Reviewed by Vendor

21.50 Packet Status Reason Text When packet status is incomplete, this fields captures the reason explaining why the packet is incomplete. O O O O US-12 Communication - Packet Received and Reviewed by Vendor

21.51 Service Attempt Result Reason This field captures the attempt level reason for not serving the servee.

Valid values:

Spreadsheet: CSD-TXLP-SOP Vendor Implementation/Artifacts/Request&Attempt_Result Codes.xlsx Column - "Service Attempt Level"

If an invalid reason is reported on this field, then a SOAP fault with error message "IEPD21 Invalid Service Attempt Result Reason" is returned. O O O O US-17 Communicate Attempt Result (Portal)

21.52 Service attempt Overall attempt result per address This field captures the overall attempt result per address reason for not serving the servee.

Valid values:

Spreadsheet: CSD-TXLP-SOP Vendor Implementation/Artifacts/Request&Attempt_Result Codes.xlsx Column - "Address Result"

If an invalid reason is reported on this field, then a SOAP fault with error message "IEPD21 Invalid Service attempt Overall attempt result per address" is returned. O O O O US-17 Communicate Attempt Result (Portal)

21.53 Service Request Comments Text field which captures the comments from the vendor for OAG staff. O O O O US-61 Exchange Information with EZM

Comments can be communicated to OAG using "Miscellaneous Updates" transaction type.

21.54 Affidavit Submitted Date Affidavit submitted date with format: YYYY-MM-DD O O O O 11/10/2021 - Added for US-56 – Affidavit – Filed and Returned Dates

21.55 Affidavit File Marked Date Affidavit file marked date with format: YYYY-MM-DD O O O O 11/10/2021 - Added for US-56 – Affidavit – Filed and Returned Dates

21.56 Affidavit Returned Date Affidavit returned from court date with format: YYYY-MM-DD O O O O 11/10/2021 - Added for US-56 – Affidavit – Filed and Returned Dates

IEPD21 XML Elements Page &P of &N

Sheet2

Sheet3