Sound Control Protocol for SpeechLine Digital Wireless

SSC Developer‘s guide for SpeechLine Digital Wireless | 106/109
SSC Error List (CHG 2N/CHG 4N)
15. SSC Error List (CHG 2N/CHG 4N)
If the request message violates the JSON syntax, the complete message cannot reliably be parsed
and MUST NOT be partially parsed or executed, so that the SSC Server MUST send an error response
(400, "not understood") relating to the complete message, not to any method address.
Error method results for successful method executions MUST NOT be sent without being explicitly
requested by the client, by querying "/osc/error".
The error code is a three-digit integer, defined in the style of Hypertext Transfer Protocol (HTTP) re-
sponse status codes, the status code is part of the HTTP/1.1 standard (RFC 7231).
The first digit of the error code defines the class of response. The last two digits do not have any
categorization role.
There are 5 values for the first digit:
• 1xx - Informational response - Request received, continuing process.
• 2xx - Successful - The action was successfully received, understood, and accepted.
• 3xx - Redirection - Further action must be taken in order to complete the request.
• 4xx - Client Error - The request contained bad syntax or cannot be fulfilled.
• 5xx - Server Error - The SSC server failed to fulfill an apparently valid request.
A simple SSC Client would only have to look at the first digit of the error code in order to determine
what how to deal with the Method Reply.
15.1 1xx Informational
The 1xx (Informational) class of status code indicates an interim response for communicating con-
nection status or request progress prior to completing the requested action and sending a final re-
sponse.
15.1.1 100 Continue
The client SHOULD continue with its request. This interim response is used to inform the client that
the initial part of the request has been received and has not yet been rejected by the SSC Server. The
client SHOULD continue by sending the remainder of the request or, if the request has already been
completed, ignore this response.
The SSC Server MUST send a final response after the request has been completed.
15.1.2 102 Processing
The 102 (Processing) status code is an interim response used to inform the client that the SSC Server
has accepted the complete request, but has not yet completed it. This status code SHOULD only be
sent when the SSC Server has a reasonable expectation that the request will take significant time
to complete. As guidance, if a method is taking longer than 20 seconds (a reasonable, but arbitrary
value) to process the SSC Server SHOULD return a 102 (Processing) response.
The SSC Server MUST send a final response after the request has been completed.
15.2 2xx Success
This class of status code indicates that the client’s request was successfully received, understood,
and accepted.
15.2.1 200 OK
Standard response for successful requests.
15.2.2 201 Created
The request has been fulfilled and resulted in a new resource being created. The origin SSC Server
MUST create the resource before returning the 201 status code. If the action cannot be carried out
immediately, the SSC Server SHOULD respond with 202 (Accepted) response instead.