Practical VoIP Using VOCAL

Examples of Protocol Transmissions/Replies

In each case, we indicate what the call would look like if it were a C++ call. This is not intended to imply that such a call will directly exist in the library—it is simply a convenient mechanism for illustrating the information passed and the result expected. In most cases, when a simple 200 OK or 4XX error message is expected, we list that as a void return type.

For error conditions, we show only some of the possible error codes that could be returned. In almost all cases, other error codes could possibly be returned, but we do not list all return codes.

 void GetRecordsInDomain (string domain, string filter, list <string> fieldList) Request: GET GetRecordsInDomain HTTP/1.1 Content-Length: <arguments> <domain> Accounts </domain> <filter> uid = 100* </filter> <fieldlist> <listitem> uid </listitem> <listitem> phone </listitem> <listitem> xmlStuff </listitem> <--- Contains xml content . . . </fieldlist> </arguments> Response (Success): 200 OK HTTP/1.1 Content-Length: <response> <domain> Accounts </domain>. <resultcount> 5 </resultcount> <-- Maybe? Need to think. <match> <fieldvalue> <uid>1001</uid> <phone>4083831001</phone> <xmlStuff> <--- Xml Content ... </xmlStuff> </fieldvalue> </match> <match> <fieldvalue> <uid>1002</uid> <phone>4083839999</phone> <xmlStuff> ... </xmlStuff> </fieldvalue> </match> . . . </response> Response (Success but no matches): 204 No Content HTTP/1.1 Content-Length:0 Response (Fail): 400 FAIL HTTP/1.1 Content-Length: ...