Hazard API
We provide a full range of hazard metrics across all regions of the globe. You can find a full listing of our available hazards on the Lookup Values tab.
Hazard API is most reliable when the client provides pre-validated latitude and longitude for a location. If you’re unable to provide latitude/longitude values, please reference our Geocoding service section.
API REFERENCE - SUMMARY
Summary of Methods
Method
Description
HazardLayers
A web method that retrieves the list of available client Hazards. Return values from this web method can be used in the LocationHazardInfo web method.
LocationHazardInfo
A web method, to retrieve the Hazard information of a location. By default, the service retrieves all Hazard layer information for the location. But, there is an option in the request object to get the specific Hazard information.
API REFERENCE - DETAILED
The GC Carpenter API includes an API Explorer, a tool that helps you explore and debug GC Carpenter API endpoints. More detailed information on an endpoint is displayed in the API Explorer.
HazardLayers
Detailed information on Base URL, Action, Headers, and Body Parameters is displayed in the API Explorer.
BaseURL: [Base URL provided by GC]
Action: GET
Headers:
Content-Type: application/json
Authorization: Bearer [access_token]
Body Parameters:
N/A
The above resources should return one of the following HTTP response codes:
Responses:
Code
Status
Definition/Possible Cause
200
OK
The request was successful and a valid response returned
400
Bad Request
Validation error or wrong parameters. Returns a JSON string with “Error” description of the actual error
401
Unauthorized
An invalid or an expired token was provided
417
Expectation Failed
An invalid request payload was presented
500
Internal Server Error
An unexpected condition has occurred
LocationHazardInfo
Detailed information on Base URL, Action, Headers, and Body Parameters is displayed in the API Explorer.
BaseURL: [Base URL provided by GC]
Action: POST
Headers:
Content-Type: application/json
Authorization: Bearer [access_token]
Body Parameters:
Detailed information on Body Parameters is displayed in the API Explorer.
The above resources should return one of the following HTTP response codes:
Responses:
Code
Status
Definition/Possible Cause
200
OK
The request was successful and a valid response returned
400
Bad Request
Validation error or wrong parameters. Returns a JSON string with “Error” description of the actual error
401
Unauthorized
An invalid or an expired token was provided
417
Expectation Failed
An invalid request payload was presented
500
Internal Server Error
An unexpected condition has occurred
ERROR SUMMARY
The service returns a Fault Exception object for all errors. The Fault Exception object has a Fault Code, Description and a Fault Type that indicates if the fault was generated due to client (or sender) entry or a server (or receiver) fault.
The error codes mentioned below are some of the codes that can be used by the client applications to take appropriate actions
Error Code
AllowedRequestsPerClientPerDay
You have exceeded the maximum requests allowed per day for your account. If you believe this message is in error, please contact your support team at Guy Carpenter
ClientVersionIdRequiredException
ClientVersionId is required. Please specify.
InternalServiceError
Internal Service Error. At the moment we are unable to process your request. Please try again later. If this continues, please contact the support team at GuyCarp.com
InvalidLatitudeException
An invalid Latitude value was specified. The range of values should be from -90 to 90
InvalidLongitudeException
An invalid Longitude value was specified. The range of values should be from -180 to 180
InvalidUserNamePassword
Invalid Username or Password, UserName or Password received does not match the entry we have on file.
InvalidValueException
An unexpected value of {0} was passed for the parameter {1}!
LocationsOutOfRangeException
There should be a minimum of {0} location(s) and maximum of {1} location(s) specified.
MissingUserNamePassword
Invalid or missing Username or Password, UserName or Password received is either Null or Empty
NegativeDeductibleException
Deductible cannot be a negative value. Please provide a non-negative value.
ParticipationPercentOutOfRangeException
A specified participationPercent is out of range of {0...1}.
PoliciesOutOfRangeException
There should be a minimum of {0} Policy(ies) and maximum of {1} Policy(ies) specified.
TooManyRequests
Too many requests were received in a very short duration.
UnauthorizedAccessError
Unauthorized access detected. If you believe this message is in error, please contact the support team at GuyCarp.com
UnSupportedClientServiceError
Unsupported Client Version Id. If this problem persists, please contact the support team at GuyCarp.com
