ipOne API Documentation


survey/get_wayleave_answers

Important:  An API Key is required to work with these API Calls

List ONE assignment assigned to a user, includes customer installation details

Sample Request

http://api.verifiapp.com/survey/get_wayleave_answers/{API-KEY}/{WAYLEAVE_ID}

Sample Response

{"result":"success","results":[{"question_id":7604,"answer":"106"},{"question_id":7605,"answer":"CURRALEIGH WEST-MIDLETON"},{"question_id":7606,"answer":"0110A"},{"question_id":7607,"answer":"Murphy"},{"question_id":7608,"answer":"John Roberts"},{"question_id":7609,"answer":null},{"question_id":8076,"answer":null},{"question_id":8077,"answer":null},{"question_id":8078,"answer":null},{"question_id":7610,"answer":null},{"question_id":7611,"answer":"55 Beechpark Road"},{"question_id":7612,"answer":"Foxrock"},{"question_id":7613,"answer":"Dublin 18."},{"question_id":7614,"answer":null},{"question_id":7615,"answer":null},{"question_id":7616,"answer":"BGE\/106\/WL\/026\/110A (REV. 0)"},{"question_id":7617,"answer":null},{"question_id":7618,"answer":"0"},{"question_id":7619,"answer":"0"},{"question_id":7620,"answer":"0"},{"question_id":7621,"answer":"0"},{"question_id":8075,"answer":"0"}]}

Important, you have to send the wayleave ID. That's in installation > id. It's not the wayleave_no field, it's the ID. This API call is only available for the installations of type "wayleave".

You will receive an associative array with question_id and answer. If something is unavailable, it would contain NULL.

Note that these answers are only valid for the "BGE- Land Agency Visit Form" questionnaire, which is the relevant one.

Successful Response Reference

A successful response will return the following item in a JSON array

Preference Description
result success
results Array relating question_ids and answer values.

Unsuccessful Response Reference

A unsuccessful response will return the following items in a JSON array

Preference Description Sample response
result error  
error The specific error is described in the response Invalid API Key