API Guide

S2. Standard XML Schemas

2.1. ServiceRequest XML Envelope The ServiceRequest XML envelope is used for Services that require Method parameters to be passed as XML in the Request Input Stream.

<ServiceRequest
    ServiceName=““ 
    ServiceMethod=““ 
    RequestDate=““ 
    RequestId=””
    SecurityToken=””
    UserName=”” >

    <RequestUser 
        UserId=““ 
        UserName=““ 
        FirstName=””
        LastName=””
        Email=””
        ExternalId=””
        ExternalRef=””
        ExternalData=””
        ExternalFlags=””  
    />

    <RequestParameters>
        <Parameter Name=”” DataType=”string”></Parameter>
        <Parameter Name=”” DataType=”number”></Parameter>
        <Parameter Name=”” DataType=”xml”>
            <someXmlStructure>
            </someXmlStructure >
        </Parameter>
        <Parameter DataType=”cdata”>
            <![CDATA[Some interesting data .]]>
        </Parameter>
        <Parameter Name=”” DataType=”file” FileName=”” ContentType=”” FileExtension=”” IsBase64=””>
        Base64 or text data.
        </Parameter>
    </RequestParameters>

    <RequestData>… varies by method ….</RequestData>

</ServiceRequest>

  ServiceRequest Node Attributes

RequestUser Node Attributes

Request Parameter Node Attributes

2.2. ServiceResponse XML Envelope All Methods must return their result data wrapped in a common Response XML envelope. This gives XDOC a consistent way to interpret success or failure and retrieve the result data from the method, as well as provides data that can be useful for debugging the integration.

<ServiceResponse 
    ServiceName=““ 
    ServiceMethod=““ 
    RequestDate=““ 
    RequestId=““ 
    Success=“1” 
    ResponseDate=““ 
    ResultCode=““ 
    ResultInfo=““ 
    ResultMessage =““ >
    <ResponseData>… varies by web method…</ ResponseData >
    <ResponseTrace>Error stack trace in the event of an error</ResponseTrace>
</ ServiceResponse>

Response XML Notes:

• Success is generally always set = 1, unless there is some kind of critical error that occurred in the Integrated Application. It is never used to indicate Application Logic conditions.

Standard Result Codes and Conditions:

• Note: The following result codes should be used for common error conditions as noted. These are purposefully intended to correspond to standard HTTP result codes.

2.3. Container XML Many of the Service Methods return information about the Business Entity in the Integrated Application. This is referred to as the Container and represents the IContainerInfo interface in the XDOC system. A container is intended to be a simple business object that has the following:

• A minimal set of known attributes that XDOC is expecting and needs to function properly. These are the attributes in the node below.
• An arbitrary set of other simple typed attributes. The node below.
• Optional Security flags from the Integrated Application indicated if the user’s access to the object.
• Zero or more lists of values that represent Master-Detail type Collections of simple object.

Following is sample Container XML representing a Loan from a Loan Processing System (Integrated Application).

<Container
    Key=””
    Reference=””
    Name=””
    Label=””
    Description=””>
    <Attributes 
        LoanNumber=”1234”
        LoanPurpose=”Cash-Out Refi” />
    <Security 
        ReadOnly=”0”
        HideDocumentImages=”0”
        Profile=”Underwriter”   />
    <Lists>
        <List Name=”BORROWER”>
           <ListItem Name=”Joe Smith” Value=”12345” />
           <ListItem Name=”Jane Smith” Value=”6789” />
        </List>
        <List Name=”BORROWER-PRIMARY”> 
           <ListItem Name=”Joe Smith” Value=”12345” />
        </List>
        <List Name=”BORROWER-COMBINED”> 
           <ListItem Name=”Joe Smith” Value=”12345” />
           <ListItem Name=”Jane Smith” Value=”6789” />
           <ListItem Name=”Joe and Jane Smith” Value=”1234456789” />
        </List>
    </Lists>
    <UserRoles>
        <UserRole RoleName=”Underwriter” RoleValue=”UW” UserName=”jsmith” UserDisplay=”John Smith” UserEmail=”jsmith@gmail.com” />
        <UserRole RoleName=”Broker” RoleValue=”BR” UserName =”jdoe” UserDisplay =”Jane Doe” UserEmail=”jdoe@gmail.com” />
    </UserRoles>
</ Container >

Container Node Attribute Reference

Security Node Attribute Reference

Attribute Node Reference

Lists Node Attribute Reference

List Item Node Attribute Reference

User Role Node Attribute Reference

2.4. ContainerList XML A list of containers. Used primarily by search Methods that return lists of matching Containers.

<ContainerList>
   <Container />
   <Container />
</ContainerList>

2.5. SearchCriteria XML Represents a list of Search Criteria that the Integrated Application will use to search and return ContainerList XML or other Application specific result sets. This XML structure is used as input to various Service Methods. Note: This is a simple search criteria structure where the SearchField nodes are generally assumed to be a set of “And” conditions.

<SearchCriteria>
   <SearchField Code=”” Value=”” Operator=”” />
   <SearchField Code=”” Value=”” Operator=”” />
</SearchCriteria>

SearchField Node Attribute Reference

Search Operator Reference

2.6. List XML Represents a simple list of Name / Value pairs.

<List>
   <ListItem Name=”” Value=”” />
   <ListItem Name=”” Value=”” />
</List>