Changes between Version 5 and Version 6 of UniformClearinghouseAPI


Ignore:
Timestamp:
08/14/13 15:13:55 (6 years ago)
Author:
jmccolga@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UniformClearinghouseAPI

    v5 v6  
    146146
    147147      “MEMBER_ENABLED”: {“TYPE”: “BOOLEAN”, “UPDATE”: TRUE}
     148    }
     149
     150}
     151
     152The following is an example of a return from a get_version from a CH, provided in JSON-like syntax:
     153
     154{
     155      “VERSION”: “10.0.7”,
     156
     157      “FIELDS”: {
     158
     159              “SERVICE_DESCRIPTION”: {“TYPE”: “STRING”}}
     160
     161     }
     162
     163}
     164
     165== API Error Handing ==
     166
     167All method calls return a tuple [code, value, output]. What is described as ‘Return’ in the API’s described below is the ‘value’ of this tuple in case of a successful execution. ‘Code’ is the error code returned and ‘output’ is the returned text (e.g. descriptive error message).
     168
     169Each CH and Authority is free to define and return its own specific error codes. However we suggest the following essential set of error codes to report on generic conditions:
     170