Generic response description

If no other mention of the response format is used, the generic response format will be. Based on a JSON-object with a result and a message name/value-pair.

The result value will be set to three different (AA, AR and AE) abbreviations used MSA segment in a HL7 ACKR01 message advocated by Continua Design Guidelines. Each abbreviation also corresponds to a typical status code in the LinkWatch API. Below is a list of the meaning and status code used.

Abbreviation	Meaning	Status code
AA	Application accepted	200
AR	Application rejected	400, 401
AE	Application error	500

The message value will be set to some contextual information depending on the context it’s used. For instance, a failed login attempt will show “Invalid username or password”.

Examples

Response

StatusCode: 200

Body

{
"Result": "AA",
"Message": ""
}

Response

StatusCode: 401

Body

{
"Result": "AR",
"Message": "Invalid username or password"
}

Response

StatusCode: 500

Body

{
"Result": "AE",
"Message": "Internal server error"
}