VitalWare API

<back to all web services

SherpaConceptInformation

The following routes are available for this service:
GET POST/sherpaConceptInformationGet concept Info for a Concept ID
GET POST/sherpaConceptInformation/{conceptBaseId}Get XML concept Info for a Concept IDConcept Base ID can be directly within the URL as part of the path
Parameters:
NameParameterData TypeRequiredDescription
conceptBaseIdpathintNoThe conceptBaseId of the concept to find information on

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.

POST /json/reply/SherpaConceptInformation HTTP/1.1 
Host: api.vitalware.com 
Content-Type: application/json
Content-Length: length

{"conceptBaseId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"request":{"conceptBaseId":0},"result":{"parameters":{"param":[{"type":"String","value":"String","hasInfo":false,"isAlias":false,"isDIndex":false,"position":0}]},"messages":[{"message":"String"}],"results":{"selectedDiagnosisTotal":{"count":0},"selectedDiagnosisPageset":{"diagnosis":[{"id":0,"code":"String","codeAlt":"String","desc":"String"}]},"selectedConcepts":{"conceptType":[{"type":"String","typeID":0,"count":0,"concepts":{"concept":[{"id":0,"desc":"String","count":0,"hasInfo":false}]}}]},"infoNodes":{"info":[{"typeID":0,"type":"String","label":"String","title":"String","description":"String"}]},"instructions":{"type":"String","instructionType":[{"type":"String","instruction":[{"instruction":"String","codeRanges":"String"}]}]}}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String"}]}}