{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Use the following example classes to deserialize the JSON returned by the REST api.","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"csharp"},"marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"using Newtonsoft.Json;\nusing Newtonsoft.Json.Converters;\nusing System;\nusing System.Collections.Generic;\n\nnamespace com.doforms.rest.client\n{\n public class Blob\n {\n public string key { get; set; }\n public string id { get; set; }\n public string type { get; set; }\n }\n public class Column\n {\n public string name { get; set; }\n public string caption { get; set; }\n }\n public class Choice\n {\n public string text { get; set; }\n public Label label { get; set; }\n }\n public class Device\n {\n public string key { get; set; }\n public string name { get; set; }\n public string carrier { get; set; }\n public DateTimeOffset createTime { get; set; }\n public DateTimeOffset formTime { get; set; }\n public string model { get; set; }\n public string number { get; set; }\n public string os { get; set; }\n public string teamKey { get; set; }\n public DateTimeOffset updateTime { get; set; }\n public string version { get; set; }\n }\n public class Email\n {\n public List addresses { get; set; }\n public string message { get; set; }\n }\n public class Error\n {\n public string code { get; set; }\n public string request { get; set; }\n public string exception { get; set; }\n public string message { get; set; }\n }\n public class Fax\n {\n public List addresses { get; set; }\n public string message { get; set; }\n }\n public class Field\n {\n public string name { get; set; }\n [JsonProperty(\"data\")]\n [JsonConverter(typeof(StringEnumConverter))]\n public DataType data { get; set; }\n [JsonProperty(\"type\")]\n [JsonConverter(typeof(StringEnumConverter))]\n public ControlType type { get; set; }\n //Begin data fields\n public Blob blob { get; set; }\n public DateTimeOffset? date { get; set; } //Ignore the time value which will always be 00:00:00Z\n public DateTimeOffset? datetime { get; set; }\n public Email email { get; set; }\n public Fax fax { get; set; }\n public long? integer { get; set; }\n public Location location { get; set; }\n public double? number { get; set; }\n public List strings { get; set; }\n public string text { get; set; }\n public DateTimeOffset? time { get; set; } //Ignore date value which will always be Jan 1, 1970\n //End data fields\n public string value { get; set; } //Default value\n public Options options { get; set; }\n public List choices { get; set; }\n public List fields { get; set; }\n public List rows { get; set; }\n }\n public class Form\n {\n public string key { get; set; }\n public string id { get; set; }\n public string name { get; set; }\n public string displayName { get; set; }\n public DateTimeOffset createTime { get; set; }\n public string createUser { get; set; }\n public DateTimeOffset updateTime { get; set; }\n public string updateUser { get; set; }\n public double version { get; set; }\n public List fields { get; set; }\n }\n public class Label\n {\n public string en { get; set; }\n }\n public class Location\n {\n public double? latitude { get; set; }\n public double? longitude { get; set; }\n public double? altitude { get; set; }\n public double? accuracy { get; set; }\n }\n public class Lookup\n {\n public string key { get; set; }\n public string name { get; set; }\n public string description { get; set; }\n public bool useForm { get; set; }\n public bool useFilter { get; set; }\n public string formKey { get; set; }\n public string projectKey { get; set; }\n public bool update { get; set; }\n public bool encrypt { get; set; }\n public long version { get; set; }\n public DateTimeOffset createTime { get; set; }\n public string createUser { get; set; }\n public DateTimeOffset updateTime { get; set; }\n public string updateUser { get; set; }\n public List columns { get; set; }\n }\n public class Options\n {\n public bool comment { get; set; }\n public string format { get; set; }\n public Label label { get; set; }\n public int level { get; set; }\n public string prefix { get; set; }\n public long? rows { get; set; }\n }\n public class Project\n {\n public string key { get; set; }\n public string name { get; set; }\n }\n public class Row\n {\n public long index { get; set; }\n public List fields { get; set; }\n }\n public class Submission\n {\n public string key { get; set; }\n public string id { get; set; }\n public string name { get; set; }\n public string formKey { get; set; }\n public string formName { get; set; }\n public double formVersion { get; set; }\n public string projectKey { get; set; }\n public int offset { get; set; }\n public string timezone { get; set; }\n public DateTimeOffset receiveTime { get; set; }\n public List fields { get; set; }\n }\n public class Team\n {\n public string key { get; set; }\n public string name { get; set; }\n }\n\n public class TokenRequest\n {\n public string username { get; set; }\n public string password { get; set; }\n public string account { get; set; }\n public string code { get; set;}\n public string webservice { get; set; }\n }\n public class TokenResult\n {\n public string token { get; set; }\n public string code { get; set; }\n public string[] accounts { get; set; }\n public string message { get; set; }\n }\n public enum ControlType\n {\n action,\n approval,\n audio,\n autonumber,\n barcode,\n bluetooth_le,\n button,\n button_grid,\n calculation,\n choose_one,\n choose_multiple,\n comment,\n counter,\n date_time,\n email,\n fax,\n forward,\n grid,\n image,\n instruction,\n label,\n location,\n lookup,\n nfc,\n numeric,\n page,\n payment,\n pod,\n question,\n questionnaire,\n repeat,\n retrieve,\n schedule,\n score,\n score_summary,\n signature,\n sketch,\n table,\n text,\n trends,\n video\n }\n public enum DataType\n {\n blob,\n date,\n datetime,\n email,\n fax,\n fields,\n integer,\n location,\n number,\n rows,\n strings,\n text,\n time\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"csharp"},"marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"using Newtonsoft.Json;\nusing System;\nusing System.Collections.Generic;\nusing System.Net;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Text;\n\nnamespace com.doforms.rest.client\n{\n class Program\n {\n static void Main(string[] args)\n {\n HttpClient client = new HttpClient();\n client.BaseAddress = new Uri(\"https://api.mydoforms.com/api/v2/\");\n client.DefaultRequestHeaders.Accept.Clear();\n client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(\"application/json\"));\n\n //Get authorization token\n Console.WriteLine(\"Getting token\");\n TokenRequest tokenRequest = new TokenRequest();\n tokenRequest.username = \"myusername\";\n tokenRequest.password = \"mypassword\";\n StringContent tokenContent = new StringContent(JsonConvert.SerializeObject(tokenRequest), Encoding.UTF8, \"application/json\");\n HttpResponseMessage tokenResponse = client.PostAsync(\"tokens/user\", tokenContent).Result;\n //TODO: Check response code first for all requests\n TokenResult tokenResult = JsonConvert.DeserializeObject(tokenResponse.Content.ReadAsStringAsync().Result);\n string token = tokenResult.token;\n client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Bearer\", token);\n\n //Get the list of projects\n Console.WriteLine(\"Getting projects\");\n HttpResponseMessage projectsResponse = client.GetAsync(\"projects\").Result;\n List projects = JsonConvert.DeserializeObject>(projectsResponse.Content.ReadAsStringAsync().Result);\n foreach (Project project in projects)\n {\n Console.WriteLine(\"Project: \" + project.name);\n }\n\n //Get the list of forms in the project\n Console.WriteLine(\"Getting forms for project \" + projects[0].name);\n HttpResponseMessage formsResponse = client.GetAsync(\"projects/\" + projects[0].key + \"/forms\").Result;\n List

forms = JsonConvert.DeserializeObject>(formsResponse.Content.ReadAsStringAsync().Result);\n foreach(Form form in forms)\n {\n Console.WriteLine(\"Form: \" + form.name);\n }\n\n //Get a form definition\n Console.WriteLine(\"Getting definition for form \" + forms[0].name);\n HttpResponseMessage formResponse = client.GetAsync(\"forms/\" + forms[0].key).Result;\n Form definition = JsonConvert.DeserializeObject(formResponse.Content.ReadAsStringAsync().Result);\n foreach(Field field in definition.fields)\n {\n Console.WriteLine(\"Field: \" + field.name);\n }\n\n //Get the first submission in the form\n Console.WriteLine(\"Getting submission \" + definition.id + \"&&1\");\n HttpResponseMessage submissionResponse = client.GetAsync(\"submissions/\" + definition.id + \"&&1\").Result;\n if (submissionResponse.StatusCode.Equals(HttpStatusCode.OK))\n {\n Submission submission = JsonConvert.DeserializeObject(submissionResponse.Content.ReadAsStringAsync().Result);\n Console.WriteLine(\"Submission: \" + submission.key);\n }\n else\n {\n Error error = JsonConvert.DeserializeObject(submissionResponse.Content.ReadAsStringAsync().Result);\n Console.WriteLine(\"Error message: \" + error.message);\n }\n Console.ReadLine();\n }\n }\n} ","type":"text"}]}],"version":1}

Browser not supported