OrderService
Click here for a complete list of operations.
OrderStatusUpdate
Used For Example only - non functional on this site.
When configured by ValueCheck to do so, this customer implemented method will be called by the ValueCheck Title Automation Systems when an order has moved to a different stage.
Below are the stages that an order moves through. Notifications will be sent as indicated by the arrows.
Notes on usage:
- It must be implemented by the customer as an HTTP-SOAP Web Service.
- ValueCheck must enable which events will trigger the calling of this method based on the AppId.
- Each order that needs notification must have the 'ClientWebServiceAddress' set to the URL of the Web Service that implements this method when it is posted to ValueCheck.
- The events that can trigger the calling of this method are:
Event Description Status Value Description 1 Research Order is now in research/processing at Valuecheck. 2 Examination Order is done with research and is ready for customer examination. 3 Completed Order examination is completed and the prepared documents and images are being published to the customer. 4 Published Order documents and images are now published. -1 ResearchProblem There is a problem with researching the order. Most likely the customer needs to supply more information. -2 UnknownProblem There is a problem with the order. Most likley ValueCheck will need to intervene.
| Argument | Description | ||||||||||
| order | The Order identifier.
| ||||||||||
| status | The status of the order. Will be one of the events described above. | ||||||||||
| statusInfo | More infomation about the order. Most likely will contain a textual description about a problem. | ||||||||||
| orderInfoXml | More information about the order in a structure customized for the customer if neeeded. |
| Return | Description |
| AccountNum | Must be the same as sent in the order. |
| OrderNum | Must be the same as sent in the order. |
| Sts | Zero to acknowledge the status update. Non-Zero to indicate a problem. |
| Description | Textual information about the Sts. |
| StsDate | TimeStamp of response. |
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/OrderStatusUpdate"
<?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>
<OrderStatusUpdate xmlns="http://TitleAutomation.valuecheck.com/">
<order>
<VCAppID>int</VCAppID>
<VCClientID>int</VCClientID>
<AccountNum>string</AccountNum>
<OrderNum>string</OrderNum>
<Submitted>dateTime</Submitted>
</order>
<status>Unknown or Research or Examination or Completed or Published or ResearchProblem or UnknownProblem or DoesNotExist or NotAuthorized</status>
<statusInfo>string</statusInfo>
<orderInfoXml>string</orderInfoXml>
</OrderStatusUpdate>
</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>
<OrderStatusUpdateResponse xmlns="http://TitleAutomation.valuecheck.com/">
<OrderStatusUpdateResult />
</OrderStatusUpdateResponse>
</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>
<OrderStatusUpdate xmlns="http://TitleAutomation.valuecheck.com/">
<order>
<VCAppID>int</VCAppID>
<VCClientID>int</VCClientID>
<AccountNum>string</AccountNum>
<OrderNum>string</OrderNum>
<Submitted>dateTime</Submitted>
</order>
<status>Unknown or Research or Examination or Completed or Published or ResearchProblem or UnknownProblem or DoesNotExist or NotAuthorized</status>
<statusInfo>string</statusInfo>
<orderInfoXml>string</orderInfoXml>
</OrderStatusUpdate>
</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>
<OrderStatusUpdateResponse xmlns="http://TitleAutomation.valuecheck.com/">
<OrderStatusUpdateResult />
</OrderStatusUpdateResponse>
</soap12:Body>
</soap12:Envelope>