field_block:node:guide:title

eCRV Web Services API

field_block:node:guide:body

The Minnesota Department of Revenue offers Simple Object Access Protocol (SOAP) based web services for local government agencies processing electronic Certificates of Real Estate Value (eCRVs). Below is information development staff need to use the eCRV Web Services interface, including:

Purpose of each Web Service
Design considerations important for using the interface
Web Services Description Language (WDSL) to define the service
Extensible Markup Language (XML) schemas to define the content

To use this guide, you should be familiar with SOAP-based interfaces, WSDL definitions, and XML schemas.

For information about getting started with Web Services, contact eCRV Support.

field_block:node:guide:field_paragraph

Security and Authentication [+]

Authentication

User authentication credentials (user ID and password) are transmitted as part of the SOAP header in the web service request.

Authentication occurs at the beginning of each web service call, so a persistent user session is not created.

The eCRV Web Services application uses Username Token Profile V1.0 (pdf) specification, part of the OASIS Web Services Security (WS-Security) specification.

Getting a Username

The username your system uses is assigned when you begin using the eCRV Web Services interface. To get a username, contact eCRV Support.

Sample Header with Username and Password

The code below shows the correct format for the Web Services header. Specific elements are explained in the table below the code. All of the elements are required.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header>
<wsse:Security SOAP-ENV:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-ocurity-secext-1.0.xsd" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-ocurity-utility-1.0.xsd">
<wsu:Timestamp wsu:Id="TS-BBB4D9312FCBD984BE15753056690802">
<wsu:Created>2019-12-02T16:54:29.080Z</wsu:Created>
<wsu:Expires>2019-12-02T16:59:29.080Z</wsu:Expires>
</wsu:Timestamp>
<wsse:UsernameToken wsu:Id="UsernameToken-BBB4D9312FCBD984BE15753056690771">
<wsse:Username>########</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">########</wsse:Password>
<wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">P1W25ZNQ4RLlS2FkqX22NQ==</wsse:Nonce>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Element	Description
<wsse:Username>	Username <wsse:Username>########</wsse:Username>
<wsse:Password>	Password for the specified <Username> sent as plain text <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">########</wsse:Password>
<wsse:Nonce>	Randomly generated cryptographic token to prevent theft and replay attacks <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">P1W25ZNQ4RLlS2FkqX22NQ==</wsse:Nonce>
<wsu:Timestamp>	Identifies when message was created and is validated against xsd:dateTime type defined in the XML schema Must be formatted in UTC format <wsu:Timestamp wsu:Id="TS-BBB4D9312FCBD984BE15753056690802"> <wsu:Created>2019-12-02T16:54:29.080Z</wsu:Created> <wsu:Expires>2019-12-02T16:59:29.080Z</wsu:Expires> </wsu:Timestamp>

Available eCRV Web Services [+]

The eCRV Web Services offered are listed below. More details for each Web Service (including the purpose, sample code, and URLs to access both the test and production region) are found in the relevant page in this guide.

Web Service Name	Description	Action Type
Download	Download up to 100 eCRVs through a request by either eCRV ID or Parcel ID.	Read
Search	Return a list of eCRV IDs matching search parameters provided in the request.	Read
Lookup	Look up data values related to eCRV, such as Property Type codes or active workflow codes at your organization.	Read
Upload Parcel	Add one or more Parcel IDs to an existing eCRV.	Update (Insert)
Upload	Add parcel-specific data to a Parcel ID that already exists on an eCRV. Cannot be used to add a Parcel to an eCRV.	Update (Modify)
Upload County Data	Add or modify data elements of the County Data for an eCRV, including: Water influence, sales adjustments, and study indicators.	Update (Modify)
Update Property Attribute	Currently being phased out. It will be replaced by Upload County Data.	Update (Modify)
Route	Change the Workflow Step an eCRV is assigned to.	Update (Modify)
Delete Parcel	Delete one or more Parcel IDs from an existing eCRV.	Update (Delete)

Technical Agreement [+]

Revenue offers eCRV Web Services as an additional tool for processing eCRVs.

Technical Updates and Communication

Revenue has agreed to the following:

The eCRV Web Services are available on business days between 7:00 a.m. and 4:30 p.m.
- Exceptions include monthly system patching or downtime as part of application updates.
Updates to eCRV Web Services and planned downtime are announced using GovDelivery.
Changes to eCRV Web Services are available in the Test Region for 30 days before a production release.
- Exceptions are made for urgent issues, and details will be communicated through GovDelivery.

Technical Support

The information provided is supplemental to the contents of the WSDL and XML schemas.

Any local government agency choosing to use the Web Services offered should have the tools and staff available to support their process. Revenue does not provide training or implementation services related to the eCRV Web Services.

If you suspect a problem or have a question about a Web Service you are using, contact eCRV Support.

Guide Menu

eCRV Web Services API