URL Format Representational State Transfer (REST) Web Service

Version

V3X1 (Major Version 3, Minor Version 1)

Description

Our Access Key web service generates a secure Access Key for registered hollandregional.com users. Use your Access Key to identify and authenticate your calls to all other web services.

URL format (REST/URLweb service)

https://api.hollandregional.com/api/AccessKey/doAccessKey?username=&password=

Request structure

Parameter Value Description
username String (required) hollandregional.com user id
password String (required) hollandregional.com password

Response structure

Parameter Value Description
STATUS:CODE Integer Status code of the response. Valid values are:

0: Success

1: Error
STATUS:ERROR_TYPE String Error type returned if applicable. Valid values are:
AUTHENTICATION_ERROR: Invalid hollandregional.com credentials were supplied
INPUT_ERROR: Error in input parameters
PROCESSING_ERROR: Internal processing error. Please retry or contact hollandregional.com Support
NOT_FOUND_ERROR: Requested information not found
NOT_ALL_FOUND_ERROR: Some requested information not found
STATUS:VIEW String Response View. Valid values are:
PUBLIC: Unsecured view.
Returned when service is invoked with no credentials or when business rules prevent access to secured information.
SECURED: Secured View. Complete information including secured data.
ERROR: Error View.
STATUS:MESSAGE String Error message (if applicable)
STATUS:VERSION:CURRENT String Version of service. Format is V[Major version number]X[Minor version number]
STATUS:VERSION:CURRENT_RELEASE_DATE Date Release date of service. Format is MM/DD/YYYY
STATUS:VERSION:LATEST String Latest available version of this service. Format is V[Major version number]X[Minor version number]
STATUS:VERSION:LATEST_RELEASE_DATE Date Release date of latest available service. Format is MM/DD/YYYY
ACCESSKEY String Access Key
ACCESSKEY_ENCODED String URL Encoded Access Key. Use this for constructing REST URL only.