OrderService
Click here for a complete list of operations.
PostOrderXml
Adds an order to the ValueCheck Title Processing Engine.
ValueCheck will supply AdminId, UserName, Password, VCAppId, and VCClientID.
Client assigns the AccountNum (for use as Department/Accounting code) and OrderNum (each order must be unique in the VcAppId Group)
The details of the order can be sent in a custom XML fragment (ValueCheck will need to write a custom parser) or the default ValueCheck Schema can be used.
| AdminID | Admin Identifier provided by ValueCheck. |
| UserID | User Identifier provided by ValueCheck. |
| Password | Password provided by ValueCheck. |
| VCAppID | Application Identifier provided by ValueCheck. |
| VCClientID | Customer Identifier provided by ValueCheck. |
| AccountNum | Customer supplied Identifier to indicate individual user or Account. |
| OrderNum | Unique Order Number assigned to this order. |
| Submitted | Timestamp of this request. |
| Xml | Details of the Request. See below. |
| Name | Description | Required |
| ClientWebServiceAddress | The URL of the Customer’s Web Service for the ValueCheck Order Processing Engine to post document ready notifications. A string of this format is expected:
https://www.yourcompany.com/TA_WS/OrderService.asmx The Client's Web Service should implement the method OrderReady that is described later in this document. | Only called if configured at ValueCheck to notify that the orders is completed. |
| ClientWebServiceAddressForDelete | The URL of the Customer’s Web Service for the ValueCheck Order Processing Engine to post order deleted notifications. A string of this format is expected:
https://www.yourcompany.com/TA_WS/OrderService.asmx The Client's Web Service should implement the method OrderDeleted that is described later in this document. | Only called if configured at ValueCheck to notify that the orders is deleted. |
| ClientCompanyName | Name of the Customer’s Company | |
| ClientOrderedBy | Name of the user requesting the order (may be overwritten for Officer Code processing by ValueCheck) | |
| ClientOrderedByName | Name of the user requesting the order. Similar to ClientOrderedBy but is not modified. | |
| ClientPhone | Phone number of the user. | |
| ClientFAX | FAX number of the user. | |
| ClientAddress | Customer’s Address | |
| ClientCityState | Customer’s City and State | |
| ClientEmail | Client Email | |
| PropAddress | Address of the Property | Yes |
| PropCity | City of the Property | Yes |
| PropState | State of the Property | Yes |
| PropZip | Zip of the Property | |
| PropCounty | County of the Property | Yes |
| PropPIN | Parcel number or APN of the Property | No; but very helpful |
| PropDoc | Document Number that has the legal/pin to search for | |
| PropLegal | Legal Description of the Property | |
| PropLot | Lot of the Property | |
| PropHLot | High Lot of the Property | |
| PropBlock | Block of the Property | |
| PropVolume | Volume of the Property | |
| PropPage | Page of the Property | |
| PropSub | Subdivison name of the Property | |
| Borrower1FirstName (deprecated - use Names node) | First Name of Borrower #1. Put optional middle name/initial after first name. | |
| Borrower1LastName (deprecated - use Names node) | Last Name of Borrower #1 | |
| Borrower1Name (deprecated - use Names node) | Put complete borrower 1 name if unable to use above Borrower1FirstName and Borrower1LastName fields | |
| Borrower2FirstName (deprecated - use Names node) | First Name of Borrower #2 Put optional middle name/initial after first name. | |
| Borrower2LastName (deprecated - use Names node) | Last Name of Borrower #2 | |
| Borrower2Name (deprecated - use Names node) | Put complete borrower 2 name if unable to use above Borrower2FirstName and Borrower2LastName fields | |
| BorrowersName (deprecated - use Names node) | Put complete borrower 1 name and borrower 2 (if one is needed) name if unable to use above Borrower fields | |
| Borrower1SSN (deprecated - use Names node) | Social Security Number of Borrower #1 (generally in the form of xxx-xx-9999 or just the last 4 digits) | |
| Borrower2SSN (deprecated - use Names node) | Social Security Number of Borrower #2 (generally in the form of xxx-xx-9999 or just the last 4 digits) | |
| AdditionalNames (deprecated - use Names node) | More Borrower Names and/or business names. Each name is separated by a ';'. The first character before the business name must be a '@'. The borrower names must be in 'LastName, FirstName MI' format.
- Alternatively, each name may sent in child elements as in
<Name>
<First>Jon</First>
<Middle>L</Middle>
<Last>Smith</Last>
</Name>
<Company>@Gigantic Trust</Company>
| |
| Names | Party names and/or business names. Each name is separated by a ';'. The first character before the business name must be a '@'. The borrower names must be in 'LastName, FirstName MI' format.
- Alternatively, each name may sent in child elements as in (valid values for type attribute are Buyer, Seller, Unknown (default) )
<Name type='Buyer|Seller|Unknown'>
<First>Jon</First>
<Middle>L</Middle>
<Last>Smith</Last>
</Name>
<Company type='Buyer|Seller|Unknown'>@Gigantic Trust</Company>
examples:
<Name type='Buyer'>
<First>Jon</First>
<Middle>L</Middle>
<Last>Smith</Last>
</Name>
<Name type='Buyer'>Smith, Jon L</Name>
<Company type='Seller'>@Home Builder</Company>
| |
| LoanNumber | Loan number. | |
| PolicyType | Policy Type | Yes. Consult with ValueCheck for valid values. |
| LoanAmount | Amount of the loan. A Numeric number (no thousands separators) | |
| PremiumAmount | Amount of the premium. A Numeric number (no thousands separators) | |
| InsuranceAmount | Amount of the insurance. A Numeric number (no thousands separators) | |
| PayoffInfo | Pay Off information | |
| SpecialInstr | Special Instructions | |
| ProposedInsured | Proposed Insured | |
| WillClose | true/false that customer will close | |
| ClosingBranch | if WillClose is true then name of the Closing Branch | |
| CloserName | if WillClose is true then name of the Closer | |
| CloserEmail | if WillClose is true then email of the Closer | |
| StdInstr | Standard Instructions | |
| SalesRep | Name of the sales rep | |
| InvoiceNumber | Invoice Number | |
| ClientDocRepOrderNum | Document Repository Order Number - only used if it is different than the OrderNum | |
| TransactionType | SoftPro Transaction Type | SoftPro integrations - YES |
| OrderType | SoftPro Order Type | SoftPro integrations - YES |
| ProductType | SoftPro Product Type | SoftPro integrations - YES |
| SpecialDocDate | Date of the last Date Down | No. But if supplied best format is YYYY-MM-DD |
Example of the default Xml for posting an Order:
<TitleOrder>
<Post VCAppId='int' VCClientID='int' AccountNum='string' OrderNum='string'>
<PropState>string</PropState>
<PropCounty>string</PropCounty>
<PropAddress>string</PropAddress>
<PropCity>string</PropCity>
<PropZip>string</PropZip>
<PropPin>string</PropPin>
<PropDoc>string</PropDoc>
<PropLegal>string</PropLegal>
<PropLot>string</PropLot>
<PropHLot>string</PropHLot>
<PropBlock>string</PropBlock>
<PropVolume>string</PropVolume>
<PropPage>string</PropPage>
<PropSub>string</PropSub>
<Names>
<Name type='Buyer|Seller|Unknown'>
<First>Jon</First>
<Middle>L</Middle>
<Last>Smith</Last>
</Name>
<Company type='Buyer|Seller|Unknown'>@Gigantic Trust</Company>
</Names>
<PremiumAmount>string</PremiumAmount>
<InsuranceAmount>string</InsuranceAmount>
<LoanNumber>string</LoanNumber>
<PolicyType>string</PolicyType>
<TaxCert>bool</TaxCert>
<LoanAmount>string</LoanAmount>
<PayoffInfo>string</PayoffInfo>
<SpecialInstr>string</SpecialInstr>
<ProposedInsured>string</ProposedInsured>
<ClientWebServiceAddress></ClientWebServiceAddress>
<ClientWebServiceAddressForDelete></ClientWebServiceAddressForDelete>
<ClientCompanyName>string</ClientCompanyName>
<ClientOrderedBy>string</ClientOrderedBy>
<ClientOrderedByName>string</ClientOrderedByName>
<ClientCompanyName>string</ClientCompanyName>
<ClientPhone>string</ClientPhone>
<ClientFAX>string</ClientFAX>
<ClientEmail>string</ClientEmail>
<ClientAddress>string</ClientAddress>
<ClientCityState>string</ClientCityState>
<WillClose>bool</WillClose>
<ClosingBranch>string</ClosingBranch>
<CloserName>string</CloserName>
<CloserEmail>string</CloserEmail>
<StdInstr>string</StdInstr>
<SalesRep>string</SalesRep>
<SpecialDoc>string</SpecialDoc>
<SpecialDocDate>string</SpecialDocDate>
<Trustee>string</Trustee>
<SpecialOrderNum>string</SpecialOrderNum>
<ClientDocRepOrderNum>string</ClientDocRepOrderNum>
<InvoiceNumber>string</InvoiceNumber>
<TransactionID>string</TransactionID>
<TransactionType>string</TransactionType>
<OrderType>string</OrderType>
<ProductType>string</ProductType>
<SpecialDocDate>string</SpecialDocDate>
</Post>
</TitleOrder>
|
| AccountNumber | The Account Number given in the request. |
| OrderNumber | The Order Number given in the request. |
| StsDate | Timestamp of the result. |
| Sts | 0 if all went well. |
| Description | A textual description of the an error status. OK if all went well. |
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /TA_WS/OrderService.asmx HTTP/1.1
Host: www.valuecheckonline.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://TitleAutomation.valuecheck.com/PostOrderXml"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostOrderXml xmlns="http://TitleAutomation.valuecheck.com/">
<order>
<AdminID>string</AdminID>
<UserID>string</UserID>
<Password>string</Password>
<VCAppID>int</VCAppID>
<VCClientID>int</VCClientID>
<AccountNum>string</AccountNum>
<OrderNum>string</OrderNum>
<Submitted>dateTime</Submitted>
<Xml>string</Xml>
</order>
</PostOrderXml>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostOrderXmlResponse xmlns="http://TitleAutomation.valuecheck.com/">
<PostOrderXmlResult />
</PostOrderXmlResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /TA_WS/OrderService.asmx HTTP/1.1
Host: www.valuecheckonline.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<PostOrderXml xmlns="http://TitleAutomation.valuecheck.com/">
<order>
<AdminID>string</AdminID>
<UserID>string</UserID>
<Password>string</Password>
<VCAppID>int</VCAppID>
<VCClientID>int</VCClientID>
<AccountNum>string</AccountNum>
<OrderNum>string</OrderNum>
<Submitted>dateTime</Submitted>
<Xml>string</Xml>
</order>
</PostOrderXml>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<PostOrderXmlResponse xmlns="http://TitleAutomation.valuecheck.com/">
<PostOrderXmlResult />
</PostOrderXmlResponse>
</soap12:Body>
</soap12:Envelope>