(Quick Reference)

70 Answers - Reference Documentation

Version: 2.1

Table of Contents

70 Answers

70.1 List

Service: List of answers

Description: This web service returns a json list of answers.

URL:

https://BASE_URL/api/VERSION/answers

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
maxLimits the number of resources requested to return.Integerno 
offsetTells where to start returning records from the entire set of results.Integerno 
orderOrders ascending or descending.Integernoasc,desc
sortOrders the results by the specified field.Stringno 

The max parameter is set to 100 by default.

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
questionIdSearch by the Id of questionIntegerno 
surveyNameWildcard search by the survey's nameStringno 
customerReferenceWildcard search by the customer's referenceStringno 
employeeReferenceWildcard search by the employee's referenceStringno 

Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Status: HTTP/1.1 200 OK

{
	"paging": {
		"total": 13,
		"max": 100,
		"offset": 0,
		"previous": null,
		"next": null
	},
	"data": [{
		"id": 22,
		"latitude": null,
		"longitude": null,
		"checkInDate": null,
		"customer": {
			"id": 16,
			"reference": "cust_A17",
			"href": "/api/v1.0/customers/16"
		},
		"user": {
			"id": 4,
			"reference": "emp-00",
			"href": "/api/v1.0/users/4"
		},
		"survey": {
			"id": 4,
			"name": "Quality and satisfaction with documentation",
			"href": "/api/v1.0/surveys/4"
		},
		"question": {
			"id": 4,
			"text": "Do you have any others comments, questions, or concerns?",
			"href": "/api/v1.0/questions/4"
		},
		"text": "photo comment",
		"questionOptionAnswers": [],
		"questionLine": null,
		"questionColumn": null,
		"photo": "https://BASE_URL/entity1-1450169988465/question/1472469520057_130x130x2.png",
		"organization": "entity1",
		"dateCreated": "2016-08-29T11:18:39Z",
		"lastUpdated": "2016-08-29T11:18:40Z",
		"responseIndex" : "ind_82547411353884",
		"lineIndex" : "ind_82547411353884"
	}, {
		"id": 23,
		"latitude": null,
		"longitude": null,
		"checkInDate": null,
		"customer": {
			"id": 17,
			"reference": "cust_A18",
			"href": "/api/v1.0/customers/17"
		},
		"user": {
			"id": 4,
			"reference": "emp-00",
			"href": "/api/v1.0/users/4"
		},
		"survey": {
			"id": 4,
			"name": "Quality and satisfaction with documentation",
			"href": "/api/v1.0/surveys/4"
		},
		"question": {
			"id": 8,
			"text": "How satisfied are you with the appropriateness of the documentation to your needs?",
			"href": "/api/v1.0/questions/8"
		},
		"text": null,
		"questionOptionAnswers": [{
			"id": 6,
			"questionOptionId": 34,
			"text": "Satisfied",
			"href": "/api/v1.0/questionOptions/34"
		}],
		"questionLine": null,
		"questionColumn": null,
		"photo": null,
		"organization": "entity1",
		"dateCreated": "2016-08-29T13:13:01Z",
		"lastUpdated": "2016-08-29T13:13:01Z",
		"responseIndex" : "ind_82547411353884",
		"lineIndex" : "ind_82547411353884"
	}]
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "invalid_param",
  "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}
{
    "error": "invalid_datetime_format",
    "error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016/08/29]"
}

Status: HTTP/1.1 500 Internal Server Error
{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}

70.2 Show

Service: Show an answer

Description: This web service return an existing answer of the specified id in JSON format

URL:

https://BASE_URL/api/VERSION/answers/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idThe numerical ID of the desired answerLongYes777

Success Output

Success case: response.status=200

{
	"id": 22,
	"latitude": null,
	"longitude": null,
	"checkInDate": null,
	"customer": {
		"id": 16,
		"reference": "cust_A17",
		"href": "/api/v1.0/customers/16"
	},
	"user": {
		"id": 4,
		"reference": "emp-00",
		"href": "/api/v1.0/users/4"
	},
	"survey": {
		"id": 4,
		"name": "Quality and satisfaction with documentation",
		"href": "/api/v1.0/surveys/4"
	},
	"question": {
		"id": 4,
		"text": "Do you have any others comments, questions, or concerns?",
		"href": "/api/v1.0/questions/4"
	},
	"text": "photo comment",
	"questionOptionAnswers": [],
	"questionLine": null,
	"questionColumn": null,
	"photo": "https://BASE_URL/entity1-1450169988465/question/1472469520057_130x130x2.png",
	"organization": "entity1",
	"dateCreated": "2016-08-29T11:18:39Z",
	"lastUpdated": "2016-08-29T11:18:40Z",
	"responseIndex" : "ind_82547411353884",
	"lineIndex" : "ind_82547411353884"
}

Failure Output

Failure case:response.status = 404
{
  "error": "not_found",
  "error_description": "The answer with the id 3 doesn't exist."
}

Failure case:response.status = 400
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}