eCRV Web Services eCRV Web Service API documentation Revision Status Index Rev. Date Description Prepared 1 8/22/2012 First edition eCRV Deveopment Team – MQ 2 10/16/2012 Added LookupService and SearchService eCRV Deveopment Team – MQ 3 12/12/2012 Modified requirement for created element on usernametoken to be optional. eCRV Deveopment Team – MQ 4 3/3/2013 Added production URL’s eCRV Deveopment Team – MQ 5 1/9/2014 Added Download Service based on parcel ID eCRV Deveopment Team –YC 6 5/14/2014 Added Upload Service eCRV Deveopment Team –YC 7 8/6/2014 Added service which updates the property attribute values eCRV Development Team--Yi Chen 8 11/4/2014 Added auditor ID Search document eCRV Development Team--YC 9 4/20/2015 Added Route Service eCRV Development Team--YC 10 9/1/2015 Updated for use code change eCRV Development Team--YC
Transcript
eCRV Web Services eCRV Web Service API documentation
Revision Status Index Rev. Date Description Prepared
1 8/22/2012 First edition eCRV Deveopment Team – MQ
2 10/16/2012 Added LookupService and SearchService eCRV Deveopment Team – MQ
3 12/12/2012 Modified requirement for created element on usernametoken to be optional.
eCRV Deveopment Team – MQ
4 3/3/2013 Added production URL’s eCRV Deveopment Team – MQ
5 1/9/2014 Added Download Service based on parcel ID eCRV Deveopment Team –YC
6 5/14/2014 Added Upload Service eCRV Deveopment Team –YC
7 8/6/2014 Added service which updates the property attribute values
eCRV Development Team--Yi Chen
8 11/4/2014 Added auditor ID Search document eCRV Development Team--YC
9 4/20/2015 Added Route Service eCRV Development Team--YC
10 9/1/2015 Updated for use code change eCRV Development Team--YC
1 | P a g e
11 7/1/2017 Added new services to upload county parcel, delete county parcel and upload county data
Whats new ........................................................................................................................................................................... 3
Introduction MN Department of Revenue offers a set of SOAP-based web services available for access by any registered eCRV organization. These Document/literal web services are available by accessing a specified URL for each service over HTTPS.
Intended Audience The primary audience for this document is the client developers responsible for implementing software solutions that will interact and utilize the eCRV Web Services. This specification document is intended to provide an understanding of the context in which the web service interface is meant to be used, the behavior of the interface, the Web Services Description Language (WSDLs) used to define the service, and any Extensible Markup Language (XML) schemas used to define the content.
References
Standard Name Website Simple Object Access Protocol (SOAP) 1.1
http://www.w3.org/TR/2000/NOTE-SOAP-20000508
Web Service Description Language (WSDL) 1.1
http://www.w3.org/TR/2001/NOTE-wsdl-20010315
Web Services Security 1.1 http://www.oasis-open.org/committees/download.php/16790/wss-v1.1-spec-os-SOAPMessageSecurity.pdf
Security The user must be authenticated on each separate invocation, and thus there is not any possibility of an intruder attempting to hijack an existing SSO session.
We require that all interactions with our web services be encrypted, and we ensure this by requiring the use of SSL to contact our web services layer; the SSL layer performs the encryption.
The authentication credentials (login ID and password) are transmitted to eCRV as part of the web services request. This means that the login ID and password are also encrypted by the SSL layer before they leave the computer generating the web services request, and are only decrypted once received by the target eCRV server.
Authentication Authentication details are transmitted as part of the SOAP header. A user’s id and password must be transmitted in the web service request. These credentials are protected by the fact that communications with eCRV web services are all encrypted using SSL. Authenticating a user does not create a persistent “user session” for this user – each separate web service call must authenticate the user separately.
eCRV Web Services uses the Username Token Profile V1.0 (pdf) specification. The Username Token Profile specification is part of the OASIS Web Services Security (WS-Security) specification.
A header containing the username and password must be passed into every request. Here's an example:
Element Required Description <wsse:Username> Yes This contains eCRV username.
<wsse:Username>1234567890</wsse:Username> <wsse:Password> Yes This contains your eCRV password for the User specified in the
<Username>. It is expected to be 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> Yes Nonce is a randomly generated, cryptographic token used to prevent theft and replay attacks. <wsse:Nonce EncodingType="http://docs.oasis-
<wsu:Timestamp> Yes This identifies when the message was created and is used to prevent replay attacks. Timestamps for created and expires are validated against xsd:dateTime type defined in XML schema. In addition all times MUST be in UTC format as specified by the XML Schema type (dateTime). Below is an example of how the element value should be formatted. 2012-12-13T15:03:25Z
WSDL/XSD Schema Definitions WSDL location and schemas can be found at the following urls based on the region you wish to use.
PRODUCTION URL: https://www.mndor.state.mn.us/ecrv_ws/services/RouteService.wsdl
PRODUCTION URL: https://www.mndor.state.mn.us/ecrv_ws/services/UploadParcelCountyService.wsdl
PRODUCTION URL: https://www.mndor.state.mn.us/ecrv_ws/services/DeleteParcelCountyService.wsdl
PRODUCTION URL: https://www.mndor.state.mn.us/ecrv_ws/services/UploadCountyDataService.wsdl
Endpoints The WSDLs contain endpoint addresses. Once you have verified your client in the certification environment, you will need to change your endpoint to point to the production servers.
Certification RouteService https://www.dortest.mdor.state.mn.us/ecrv_ws/services/RouteService Production DownloadService https://www.mndor.state.mn.us/ecrv_ws/services/DownloadService Production LookupService https://www.mndor.state.mn.us/ecrv_ws/services/LookupService Production SearchService https://www.mndor.state.mn.us/ecrv_ws/services/SearchService Production UploadService https://www.mndor.state.mn.us/ecrv_ws/services/UploadService Production UpdatePropertyAttri
Download This service will return a list of crv’s that can be accessed by the user. A download request argument can contain a maximum of 100 crv IDs. A parcel download request argument can contain a maximum of 100 parcel IDs.
Input • DownloadRequest type DownloadRequest
o CrvId (required attribute type ENUM listed below) type int • DownloadParRequest
o ParcelId (required attribute type ENUM listed below) type String
CountySearch This operation is provided to return county data related to your organization. The request will return a list of eCRV id’s that match the search criteria.
Input • CountySearchRequest type CountySearchRequest
o CurrentWorkflowStepId - optional; type int o CurrentWorkflowStepString - optional; type string o TagId - optional; type int o TagString - optional; type string o PropertyTypeGroup - optional; type propertyGroupType
Full restriction can be viewd on wsdl or looked up from lookup service o PropertyType - optional; type propertyType with restriction
Full restriction can be viewd on wsdl or looked up from lookup service o StudyYear - optional; type gYear o ParcelId - optional; type string o AuditorId - optional; type string
SAMPLE PAYLOAD SNIPPET SEARCH BY WORKFLOW STEP ID AND TAG ID <sear:CountySearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CurrentWorkflowStepId>13</sear:CurrentWorkflowStepId> <sear:TagId>7</sear:TagId> </sear:CountySearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY PARCEL ID <sear:CountySearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:ParcelId>02-18577-160-01</sear:ParcelId> </sear:CountySearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY WORKFLOW STEP ID AND PROPERTY TYPE GROUP <sear:CountySearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CurrentWorkflowStepId>13</sear:CurrentWorkflowStepId> <sear:PropertyTypeGroup>01</sear:PropertyTypeGroup> </sear:CountySearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY AUDITOR ID <sear:CountySearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:AuditorId>231001</sear:AuditorId> </sear:CountySearchRequest>
9 | P a g e
Output • CountySearchResponse type CountySearchResponse
o resultCount type int o CrvIds o CrvId - unbounded; type int o RequestErrors - optional;
• RequestError - unbounded; • ErrorString type string;
MuniSearch This operation is provided to return municipal data related to your organization. You must use a municipal login to view this data. The request will return a list of eCRV id’s that match the search criteria.
Input • MuniSearchRequest type MuniSeachRequest
o CurrentWorkflowStepId - optional; type int o CurrentWorkflowStepString - optional; type string o TagId - optional; type int o TagString - optional; type string o PropertyTypeGroup - optional; type propertyGroupType
Full restriction can be viewd on wsdl or looked up from lookup service o PropertyType - optional; type propertyType with restriction
Full restriction can be viewd on wsdl or looked up from lookup service o StudyYear - optional; type gYear o ParcelId - optional; type string o AuditorId - optional; type string
SAMPLE PAYLOAD SNIPPET SEARCH BY WORKFLOW STEP ID AND TAG ID <sear:MuniSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CurrentWorkflowStepId>13</sear:CurrentWorkflowStepId> <sear:TagId>7</sear:TagId> </sear:MuniSearchRequest>
10 | P a g e
SAMPLE PAYLOAD SNIPPET SEARCH BY PARCEL ID <sear: MuniSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:ParcelId>02-18577-160-01</sear:ParcelId> </sear:MuniSearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY WORKFLOW STEP ID AND PROPERTY TYPE GROUP <sear:MuniSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CurrentWorkflowStepId>13</sear:CurrentWorkflowStepId> <sear:PropertyTypeGroup>01</sear:PropertyTypeGroup> </sear:MuniSearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY AUDITOR ID <sear:MuniSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:AuditorId>231002</sear:AuditorId> </sear:MuniSearchRequest>
Output • MuniSearchResponse type MuniSearchResponse
o resultCount type int o CrvIds o CrvId - unbounded; type int o RequestErrors - optional;
• RequestError - unbounded; • ErrorString type string;
StateSearch This operation is provided to return state data. The data returned will contain a list of eCRV id’s that match the search criteria.
Input • StateSearchRequest type StateSearchRequest
o CountyCode type county - type string with restriction – enum(two digit county code
11 | P a g e
o PropertyTypeGroup - optional; type propertyGroupType Full restriction can be viewd on wsdl or looked up from lookup service
o PropertyType - optional; type propertyType with restriction Full restriction can be viewd on wsdl or looked up from lookup service
o StudyYear - optional; type gYear o ParcelId - optional; type string
SAMPLE PAYLOAD SNIPPET SEARCH BY COUNTY <sear:StateSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CountyCode>19</sear:CountyCode> </sear:StateSearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY PARCEL ID <sear:StateSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:ParcelId>02-18577-160-01</sear:ParcelId> </sear:StateSearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY PROPERTY TYPE GROUP <sear:StateSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:PropertyTypeGroup>01</sear:PropertyTypeGroup> </sear:StateSearchRequest>
Output • StateSearchResponse type StateSearchResponse
o resultCount type int o CrvIds o CrvId - unbounded; type int o RequestErrors - optional;
• RequestError - unbounded; • ErrorString type string;
OriginalSearch This operation is provided to return original data. The data returned will contain a list of eCRV id’s that match the search criteria.
Input • OriginalSearchRequest type OriginalSearchRequest
12 | P a g e
o CountyCode type county - type string with restriction – enum(two digit county code
o PropertyUseCodeCodeLevel1 - optional; type propertyUse Full restriction can be viewd on wsdl or looked up from lookup service
o PropertyUseCodeCodeLevel2 - optional; type propertyUse Full restriction can be viewd on wsdl or looked up from lookup service
o PropertyUseCodeCodeLevel3 - optional; type propertyUse Full restriction can be viewd on wsdl or looked up from lookup service
o ParcelId - optional; type string o AcceptedDate - optional; type gYearMonth o SaleDate - optional; type gYearMonth
SAMPLE PAYLOAD SNIPPET SEARCH BY COUNTY CODE <sear:OriginalSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CountyCode>19</sear:CountyCode> </sear:OriginalSearchRequest>
SAMPLE PAYLOAD SNIPPET SEARCH BY COUNTY CODE AND ACCEPTED DATE <sear:OriginalSearchRequest xmlns:sear="http://schemas.ecrv.mdor.state.mn.us/searchService"> <sear:CountyCode>19</sear:CountyCode> <sear:AcceptedDate>2011-10</sear:AcceptedDate> </sear:OriginalSearchRequest>
Output • OriginalSearchResponse type OriginalSearchResponse
o resultCount type int o CrvIds o CrvId - unbounded; type int o RequestErrors - optional;
• RequestError - unbounded; • ErrorString type string;
Lookup This operation is provided to return data related to your organization. The list of data returned will contain the code along with the related description.
Input • LookupRequest
o Type type LookupType type string with restriction enum documented below
ENUM Description PROPERTY_TYPE_GROUP Returns a list of property group
type codes. PROPERTY_USE Returns a list of property use
codes. PROPERTY_TYPE Returns a list of property type
codes. ACTIVE_WORKFLOW_STEPS Code for returning a list of active
workflow steps. ACTIVE_TAGS Code for returning a list of active
CountyUpload This operation is provided to upload CRV data to a CRV of the county. The CRV is identified by CrvId from input. The CRV must be accepted by the county and not transferred to either a city or the state. The parcel ID in the request must match one of the parcels already in the parcel sub tab for this CRV. The request cannot add new parcels to the CRV.
Input • CountyUploadRequest
o CrvId - required; type int o ParcelId - required; type string o MunicipalityId - optional; type string with length 4 o SchoolDistrictId - optional; type string with length 4 o CropEquivalencyRating - optional; type decimal o CropProductivityIndex - optional; type decimal
SAMPLE PAYLOAD SNIPPET UPLOAD TO county tab and parcel subtab <upl:CountyUploadRequest xmlns:upl="http://schemas.ecrv.mdor.state.mn.us/uploadService"> <upl:CrvId>7384</upl:CrvId> <upl:ParcelId>01-81401-22-999</upl:ParcelId> <upl:MunicipalityId>2000</upl:MunicipalityId> <upl:SchoolDistrictId>0199</upl:SchoolDistrictId> <upl:CropEquivalencyRating>21.11</upl:CropEquivalencyRating> <upl:CropProductivityIndex>99.99</upl:CropProductivityIndex> </upl:CountyUploadRequest>
Output • CountyUploadResponse
o CrvId - type int o ParcelCount - type int; count of parcels that is updated o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
MuniUpload This operation is provided to upload CRV data to a CRV of the city. The CRV is identified by CrvId from input. The CRV must be accepted by the county and transferred to the city but not to the state. The parcel ID in the request must match one of the parcels already in the parcel sub tab for this CRV. The request cannot add new parcels to the CRV.
Input • MuniUploadRequest
o CrvId - required; type int o ParcelId - required; type string o MunicipalityId - optional; type string with length 4 o SchoolDistrictId - optional; type string with length 4 o CropEquivalencyRating - optional; type decimal o CropProductivityIndex - optional; type decimal
SAMPLE PAYLOAD SNIPPET UPLOAD TO county tab and parcel subtab <upl:MuniUploadRequest xmlns:upl="http://schemas.ecrv.mdor.state.mn.us/uploadService"> <upl:CrvId>90557</upl:CrvId> <upl:ParcelId>01-91401-22-999</upl:ParcelId> <upl:MunicipalityId>2000</upl:MunicipalityId> <upl:SchoolDistrictId>0199</upl:SchoolDistrictId> <upl:CropEquivalencyRating>21.11</upl:CropEquivalencyRating> <upl:CropProductivityIndex>99.99</upl:CropProductivityIndex> </upl:MuniUploadRequest>
Output • MuniUploadResponse
o CrvId - type int o ParcelCount - type int; count of parcels that is updated o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
CountyUpdatePropertyAttributeService This operation is provided to upload/update property attribute data to a CRV of the county. The CRV is identified by the CrvId from input. The CRV must be accepted by the county and is not transferred to either a city or the state. Only one CRV can be updated each time.
16 | P a g e
Input • CountyUpdatePropertyAttributeRequest
o CrvId - required; type int o YearBuiltYr – optional; type int with 4 digits o NewConstructionPct – optional; type int from 0 – 100 o GrossBuildingArea – optional; type int o WaterCde – optional attribute type ENUM listed below; type string
Type enum NONE LAKE PONDS RIVER SWAMP
o DeededAcres – optional; type decimal o ExemptWetlandIndicator – optional; type boolean as true or false o ExemptPrairieIndicator – optional; type boolean as true or false o WaterName – optional; type string with maximum length 50 o WaterId – optional; type string with Maximum length 50 o ShorelineFeet - int
o CrvId - type int o SuccessString - optional o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
SAMPLE RESPONSE IF FAILURE <us:CountyUpdatePropertyAttributeResponse xmlns:us="http://schemas.ecrv.mdor.state.mn.us/updatePropertyAttributeService"> <us:CrvId>1395</us:CrvId> <us:RequestErrors> <us:RequestError> <us:ErrorString>Build Year is not valid. Use format CCYY.</us:ErrorString> </us:RequestError> </us:RequestErrors> </us:CountyUpdatePropertyAttributeResponse>
SAMPLE RESPONSE IF SUCCESS <us:CountyUpdatePropertyAttributeResponse xmlns:us="http://schemas.ecrv.mdor.state.mn.us/updatePropertyAttributeService"> <us:CrvId>1395</us:CrvId> <us:SuccessString>Updating is successfully finished</us:SuccessString> </us:CountyUpdatePropertyAttributeResponse>
MuniUpdatePropertyAttribute This operation is provided to upload/update property attribute data to a CRV of the city. The CRV is identified by the CrvId from input. The CRV must be accepted by the county and is transferred to city but not to the state. Only one CRV can be updated each time.
Input • MuniUpdatePropertyAttributeRequest
o CrvId - required; type int o YearBuiltYr – optional; type int with 4 digits o NewConstructionPct – optional; type int from 0 – 100 o GrossBuildingArea – optional; type int o WaterCde – optional attribute type ENUM listed below; type string
Type enum NONE LAKE PONDS RIVER SWAMP
o DeededAcres – optional; type decimal o ExemptWetlandIndicator – optional; type boolean as true or false o ExemptPrairieIndicator – optional; type boolean as true or false o WaterName – optional; type string with maximum length 50 o WaterId – optional; type string with Maximum length 50 o ShorelineFeet - int
o CrvId - type int o SuccessString - optional o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
SAMPLE RESPONSE IF FAILURE <us:MuniUpdatePropertyAttributeResponse xmlns:us="http://schemas.ecrv.mdor.state.mn.us/updatePropertyAttributeService"> <us:CrvId>73405</us:CrvId> <us:RequestErrors> <us:RequestError> <us:ErrorString>Build Year is not valid. Use format CCYY.</us:ErrorString> </us:RequestError> </us:RequestErrors> </us:MuniUpdatePropertyAttributeResponse>
SAMPLE RESPONSE IF SUCCESS <us:MuniUpdatePropertyAttributeResponse xmlns:us="http://schemas.ecrv.mdor.state.mn.us/updatePropertyAttributeService"> <us:CrvId>1395</us:CrvId> <us:SuccessString>Updating is successfully finished</us:SuccessString> </us:MuniUpdatePropertyAttributeResponse>
19 | P a g e
RouteService
Operations
CountyRoute This operation is provided to route a CRV to a different workflow step. The CRV is identified by CrvId from input. The CRV must be accepted by the county and not transferred to either a city or the state. The workflow code ID in the request must be a valid workflow code ID for the county.
Input
• CountyRouteRequest o CrvId - required; type int o WorkflowCodeId - required; type int o Comments - optional; type string with maximum length 250
• RequestError - unbounded • ErrorString type string
SAMPLE RESPONSE <rs:CountyRouteResponse xmlns:rs="http://schemas.ecrv.mdor.state.mn.us/routeService"> <rs:CrvId>1527</rs:CrvId> <rs:SuccessString>Route eCRV is successful.</rs:SuccessString> </rs:CountyRouteResponse>
MuniRoute This operation is provided to route a CRV to a different workflow step. The CRV is identified by CrvId from input. The CRV must be accepted by the county and is transferred to the city but not the state. The workflow code ID in the request must be a valid workflow code ID for the city.
Input
• MuniRouteRequest o CrvId - required; type int
20 | P a g e
o WorkflowCodeId - required; type int o Comments - optional; type string with maximum length 250
• RequestError - unbounded • ErrorString type string
SAMPLE RESPONSE <rs:MuniRouteResponse xmlns:rs="http://schemas.ecrv.mdor.state.mn.us/routeService"> <rs:CrvId>70428</rs:CrvId> <rs:SuccessString>Route eCRV is successful.</rs:SuccessString> </rs:MuniRouteResponse>
UploadCountyParcelService
Operations
CountyUploadParcelCounty This operation allows county to add new parcels to a CRV. The CRV is identified by CrvId from input. The CRV must have been accepted by the county but have not been transferred to city or state. The School District Id and Municipality Id must match the Ids in the eCRV database, the Municipality Id and School District Id schema can be accessed on the web service web page. ResponseCode of 0 is returned if the update is successful, otherwise 1 is returned.
Input
• CountyUploadParcelCountyRequest o CrvId - required; type int o UploadParcelCounty - required; unbounded
- Parcle_id – required; type string - ParcelSequence_id – optional; type string - Municipality_id – required; type string - SchooldDistrict_id – required; type string - CropEquivalency_rating – optional; type decimal - CropProductivity_index – optional; type decimal
o CrvId - type int o ResponseCode – type int o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
SAMPLE RESPONSE <CountyUploadParcelCountyResponse xmlns="http://schemas.ecrv.mdor.state.mn.us/uploadParcelCountyService"> <CrvId>73461</CrvId> <RequestErrors> <RequestError> <ErrorString>Parcel Id format: 99-999-99-999-9999 is incorrect, please use format: \d{2}-\d{3}-\d{2}-\d{2}-\d{4}</ErrorString> </RequestError> <RequestError> <ErrorString>Crop Equivalency Rating: 2244.0 is not valid. Use format ###.##.</ErrorString> </RequestError> <RequestError> <ErrorString>Municipality Id: 1111 is not valid for county code:27</ErrorString> </RequestError> <RequestError> <ErrorString>School District Id 2222 is not valid for county code:27</ErrorString> </RequestError> </RequestErrors> </CountyUploadParcelCountyResponse>
MuniUploadParcelCounty This operation allows city to add new parcels to a CRV. The CRV is identified by CrvId from input. The CRV must have been transferred from the county to city but have not been transferred to state. The School District Id and Municipality Id must match the Ids in the eCRV database, the Municipality Id and School District Id schema can be accessed on the web service web page. ResponseCode of 0 is returned if the upload is successful, otherwise 1 is returned.
Input • MuniUploadParcelCountyRequest
o CrvId - required; type int o UploadParcelCounty - required; unbounded
- Parcle_id – required; type string - ParcelSequence_id – optional; type string - Municipality_id – required; type string - SchooldDistrict_id – required; type string - CropEquivalency_rating – optional; type decimal - CropProductivity_index – optional; type decimal
CountyDeleteParcelCounty This operation allows county to delete parcels from CRV. The CRV is identified by CrvId from input. The CRV must have been accepted by the county but have not been transferred to city or state. ResponseCode of 0 is returned if the delete is successful, otherwise 1 is returned.
Input
• CountyDeleteParcelCountyRequest o CrvId - required; type int o Parcel_id - required; type string, unbounded
SAMPLE PAYLOAD SNIPPET COUNTY DELETE PARCEL COUNTY <del:CountyDeleteParcelCountyRequest xmlns:ds="http://schemas.ecrv.mdor.state.mn.us/deleteParcelCountyService"> <del:CrvId>73500</del:CrvId> <del:Parcel_id>99-99999-99-912</del:Parcel_id> <del:Parcel_id>99-99999-99-913</del:Parcel_id> </del:CountyDeleteParcelCountyRequest>
24 | P a g e
Output • CountyDeleteParcelCountyResponse
o CrvId - type int o ResponseCode – type int o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
MuniDeleteParcelCounty This operation allows city to remove parcels from a CRV. The CRV is identified by CrvId from input. The CRV must have been transferred from the county to city but have not been transferred to state. ResponseCode of 0 is returned if the delete is successful, otherwise 1 is returned.
Input
• MuniDeleteParcelCountyRequest o CrvId - required; type int o Parcel_id - required; type string, unbounded
CountyUploadCountyData This operation allows county to add county data such as: deed type; price adjustment; property attributes; state, county study indicators and study rejection reasons to a CRV. The CRV is identified by CrvId from input. The CRV must have been accepted by the county but have not been transferred to city or state. The upload can be divided into 4 components: deed Type, sales adjustment, property attributes and county/state study (study indicators and rejection reasons). The 4 components can be uploaded individually or together. When a component is uploaded, to ensure data integrity, the new values within the component will overwrite any existing values. It is advised to download the data then add any data that need to be kept to the upload data. ResponseCode of 0 is returned if the upload is successful, otherwise 1 is returned.
Input
• CountyUploadCountyDataRequest o CrvId - required; type int o DeedType – optional; type string o SalesAdjustment – optional; unbounded
- AdjustmentType_code – required; type enum adjustmentType - AdjustmentAmount – optional; type decimal - Notes – optional; type string
o PropertyAttribute - optional; - YearBuiltYr – optional; type string - NewConstructionPct – optional; type string - GrossBuildingArea – optional; type int - WaterCde – optional; type enum waterBody
26 | P a g e
- DeededAcres – optional; type decimal - NeighborhoodCde – optional; type string - ExemptWetlandIndicator – optional; type Boolean - ExemptPrairieIndicator – optional; type Boolean - WaterName – optional; type string - WaterId – optional; type string - ShorelineFeet – optional; type int
o StudyIndicator - optional - StateStudyRecommendedIndicator – optional; type Boolean - CountyStudyRecommendedIndicator – optional; type Boolean - StateStudyRecommendedComment – optional; type string
o StudyRejectionReason – optional; unbounded - StudyLevel_code – required; type string - RejectionReason_code – required; type enum rejectionReason - Comments – optional; type string
o CrvId - type int o ResponseCode – type int o RequestErrors - optional
• RequestError - unbounded • ErrorString type string
SAMPLE RESPONSE <uc:CountyUploadCountyDataResponse xmlns:uc="http://schemas.ecrv.mdor.state.mn.us/uploadCountyDataService"> <uc:CrvId>73518</uc:CrvId> <ResponseCode>1</ResponseCode> <uc:RequestErrors> <uc:RequestError> <uc:ErrorString>Water Id, Water Name and Shoreline Feet can be updated only if Water Value Influence is: LAKE, PONDS, RIVER or SWAMP.</uc:ErrorString> </uc:RequestError> <uc:RequestError> <uc:ErrorString>Cannot enter rejection reason if state study accepted</uc:ErrorString> </uc:RequestError> </uc:RequestErrors> </uc:CountyUploadCountyDataResponse>
SAMPLE RESPONSE <uc:CountyUploadCountyDataResponse xmlns:uc="http://schemas.ecrv.mdor.state.mn.us/uploadCountyDataService"> <uc:CrvId>73518</uc:CrvId> <ResponseCode>0</ResponseCode> <uc:RequestErrors> <uc:RequestError> <uc:ErrorString>Upload county data finished successfully.</uc:ErrorString> </uc:RequestError> </uc:RequestErrors> </uc:CountyUploadCountyDataResponse>
