Cochrane+ App API

<back to all web services

SubmitRatingSubmission

Requires Authentication
The following routes are available for this service:
POST/internalrating/rateuser
SubmitRatingSubmission Parameters:
NameParameterData TypeRequiredDescription
SubmissionsbodyList<RatingSubmissionItem>No
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
RatingSubmissionItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ValueformintNo
CommentsformstringNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /internalrating/rateuser HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	submissions: 
	[
		{
			id: 0,
			value: 0,
			comments: String
		}
	],
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}