Cochrane+ App API

<back to all web services

GetPromoteToUserOptionsRequest

Requires Authentication
The following routes are available for this service:
GET/debriefreview/promoteoptions/{Id}
GetPromoteToUserOptionsRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetPromoteToUserOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
PromotedToUserIdsformList<int>No
UserOptionsformList<DebriefPromoteToUserOption>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
DebriefPromoteToUserOption Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /debriefreview/promoteoptions/{Id} HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"promotedToUserIds":[0],"userOptions":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}