Authenticate and get a token<\/strong><\/li><\/ul>\n\n\n\n token = await Http.GetStringAsync(ServiceEndpoint + \"\/AuthToken?Username=\" + username + \"&password=\" + password);\n token = token.Replace(\"\\\"\", \"\");\n Console.WriteLine(\"New token : \" + token);<\/code><\/pre>\n\n\n\n- Select a list of projects<\/strong><\/li><\/ul>\n\n\n\n
public async Task<List<Project>> GetActiveProjects()\n {\n try\n {\n List<Project> listOfActiveProjects = new List<Project>();\n var csProjectsStr = await Http.GetStringAsync(ServiceEndpoint + \"\/Query?authToken=\" + token + \"&selectQuery=Select+Id,Name+from+Project+where+Status='In+Progress'\");\n\n XElement csProjectsXml = XElement.Parse(csProjectsStr);\n\n foreach (XElement xe in csProjectsXml.Descendants(\"Project\"))\n {\n Project prj = new Project() { Id = xe.Element(\"Id\").Value, Name = xe.Element(\"Name\").Value };\n listOfActiveProjects.Add(prj);\n }\n return listOfActiveProjects.OrderBy(o => o.Name).ToList();\n }\n catch (Exception e)\n {\n throw e;\n }\n }<\/code><\/pre>\n\n\n\n- Create a record (object : Time) <\/strong><\/li><\/ul>\n\n\n\n
public async Task<Time> SaveTimeItem(Time timeItem)\n {\n try\n {\n var xmlData = new XElement(\"Data\", \"\");\n var xmlTime = new XElement(\"Time\", \"\");\n xmlTime.Add(new XElement(\"Id\", timeItem.Id));\n if (string.IsNullOrEmpty(timeItem.Name))\n xmlTime.Add(new XElement(\"Name\", timeItem.Name));\n xmlTime.Add(new XElement(\"OwnerId\", timeItem.OwnerId));\n xmlTime.Add(new XElement(\"Work_Site\", timeItem.Work_Site));\n xmlTime.Add(new XElement(\"Date\", timeItem.Date.ToString(\"yyyy-MM-dd\"))); \/\/ DateTime format: yyyy-MM-dd HH-mm-sszz\n xmlTime.Add(new XElement(\"Description\", timeItem.Description));\n xmlTime.Add(new XElement(\"Hours\", timeItem.Hours.ToString(System.Globalization.CultureInfo.CurrentCulture)));\n xmlTime.Add(new XElement(\"Project\", timeItem.ProjectId));\n xmlTime.Add(new XElement(\"Project_Budget\", timeItem.ProjectBudgetId));\n xmlTime.Add(new XElement(\"Check_out_Date_Time\", timeItem.CheckOutDateTime.ToString(\"yyyy-MM-dd HH:mm:sszz\")));\n xmlTime.Add(new XElement(\"Check_in_Date_Time\", timeItem.CheckInDateTime.ToString(\"yyyy-MM-dd HH:mm:sszz\")));\n\n xmlData.Add(xmlTime);\n\n var content = new StringContent(\"=\" + HttpUtility.UrlEncode(xmlData.ToString()), Encoding.UTF8, \"application\/x-www-form-urlencoded\"); \/\/ we could also use FormUrlEncodedContent\n var response = await Http.PostAsync(ServiceEndpoint + \"\/DataAction\/Time?authToken=\" + token + \"&action=upsert&matchingFieldName=id\", content);\n var responseStatusCode = response.StatusCode;\n var responseBody = await response.Content.ReadAsStringAsync();\n var apiResponse = XElement.Parse(responseBody);\n Console.WriteLine(\" ### Saving Time Item PAYLOAD \\n\" + apiResponse + \"\\n ### \");\n\n timeItem.Id = apiResponse.Descendants(\"id\").First().Value;\n\n if (string.IsNullOrEmpty(timeItem.Name))\n timeItem.Name = apiResponse.Descendants(\"name\").First().Value;\n\n if ((responseStatusCode != System.Net.HttpStatusCode.OK) || (apiResponse.Descendants(\"Success\").First().Value == \"False\"))\n {\n Console.WriteLine(\"ErrorMessage : \" + apiResponse.Descendants(\"ErrorMessage\").First().Value);\n Console.WriteLine(\"Response Body : \" + responseBody);\n throw new Exception (\"There was an issue saving this Time, the server replied with the following information -- Status code: \" + responseStatusCode + \" -- Error Message : \" + apiResponse.Descendants(\"ErrorMessage\").First().Value + \" -- Please contact your administrator\\n\");\n }\n return timeItem;\n }\n catch (Exception e)\n {\n throw e;\n }\n }<\/code><\/pre>\n\n\n\n- Delete a record (object : Time)<\/strong><\/li><\/ul>\n\n\n\n
public async Task<bool> DeleteTimeItem(Time timeItem)\n {\n try\n {\n var xmlData = new XElement(\"Data\", \"\");\n var xmlTime = new XElement(\"Time\", \"\");\n xmlTime.Add(new XElement(\"Id\", timeItem.Id));\n xmlData.Add(xmlTime);\n\n var content = new StringContent(\"=\" + HttpUtility.UrlEncode(xmlData.ToString()), Encoding.UTF8, \"application\/x-www-form-urlencoded\"); \/\/ we could also use FormUrlEncodedContent\n var response = await Http.PostAsync(ServiceEndpoint + \"\/DataAction\/Time?authToken=\" + token + \"&action=delete&matchingFieldName=id\", content);\n Console.WriteLine(\"REST API DELETE call (careful with what you do on production data): \" + response);\n\n var responseStatusCode = response.StatusCode;\n var responseBody = await response.Content.ReadAsStringAsync();\n\n if (responseStatusCode != System.Net.HttpStatusCode.OK)\n {\n throw new Exception(\"There was an issue deleting this Time, the server replied with the following error -- Status code: \" + responseStatusCode + \" -- Response body : \" + responseBody + \" -- Please contact your administrator\\n\");\n }\n\n return true;\n }\n catch (Exception e)\n {\n throw e;\n }\n }<\/code><\/pre>\n\n\n\nPHP<\/h2>\n\n\n\n
Here are some samples of using the REST API with PHP.<\/p>\n\n\n\n
- Create an Opportunity<\/strong><\/li><\/ul>\n\n\n\n
<html>\n\n<head>\n <title>REST API Test - Create Opportunity<\/title>\n\n<\/head>\n\n<body>\n <?php\n function authenticate($username, $password)\n {\n $login = [\n \"Username\" => $username,\n\n \"password\" => $password,\n ];\n\n $url = sprintf(\"%s?%s\", \"https:\/\/www.cirrus-shield.net\/RestApi\/AuthToken\", http_build_query($login));\n\n $client = curl_init();\n\n curl_setopt($client, CURLOPT_VERBOSE, true);\n curl_setopt($client, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($client, CURLOPT_URL, $url);\n\n $response = curl_exec($client);\n curl_close($client);\n\n return $response;\n }\n\n function createOpportunity($urlParams, $xmlData)\n {\n $url = sprintf(\"%s?%s\", \"http:\/\/www.cirrus-shield.net\/RestApi\/DataAction\/Opportunity\", http_build_query($urlParams));\n $headers = array(\n \"Content-Type: application\/x-www-form-urlencoded\",\n \"charset=utf-8\",\n );\n\n $client = curl_init();\n\n curl_setopt($client, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($client, CURLOPT_URL, $url);\n curl_setopt($client, CURLOPT_HTTPHEADER, $headers);\n curl_setopt($client, CURLOPT_POSTFIELDS, \"=\" . $xmlData);\n curl_setopt($client, CURLOPT_POST, true);\n curl_setopt($client, CURLINFO_HEADER_OUT, true);\n curl_setopt($client, CURLOPT_SSLVERSION, 6);\n\n $response = curl_exec($client);\n curl_close($client);\n\n echo \"<br><br> HTTP Response content = \";\n print_r('<pre>');\n var_dump($response);\n print_r('<\/pre>');\n\n echo \"<br><br> POST content = \";\n\n return $response;\n }\n\n $username = \"mail@mail.com\";\n $password = \"password\";\n\n $authToken = authenticate($username, $password);\n $authToken = str_replace(\"\", \"\", $authToken);\n\n if ($authToken != '') {\n $opportunityName = filter_input(INPUT_POST, 'Name', FILTER_SANITIZE_STRING);\n $opportunityOwner = filter_input(INPUT_POST, 'Owner', FILTER_SANITIZE_STRING);\n $xmlData =\n \"<Data>\"\n . \"<Opportunity>\"\n . \"<Id><\/Id>\"\n . \"<Name>Test3<\/Name>\"\n . \"<OwnerId>user.email@company.com<\/OwnerId>\"\n . \"<\/Opportunity>\"\n . \"<\/Data>\";\n\n $urlParams = [\"authToken\" => $authToken, \"action\" => \"insert\", \"matchingFieldName\" => \"Id\",];\n\n $createOpportunity = createOpportunity($urlParams, $xmlData);\n } else {\n echo \"<br>Authentication Failed\";\n }\n ?>\n<\/body>\n\n<\/html><\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
- Select a Lead<\/strong><\/li><\/ul>\n\n\n\n
<html>\n\n<head>\n\n <title>REST API Test - Select Lead<\/title>\n\n<\/head>\n\n<body>\n\n <?php\n function authenticate($username, $password)\n {\n $login = [\n \"Username\" => $username,\n \"password\" => $password,\n ];\n\n $url = sprintf(\"%s?%s\", \"https:\/\/www.cirrus-shield.net\/RestApi\/AuthToken\", http_build_query($login));\n $client = curl_init();\n\n curl_setopt($client, CURLOPT_VERBOSE, true);\n curl_setopt($client, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($client, CURLOPT_URL, $url);\n\n $response = curl_exec($client);\n curl_close($client);\n return $response;\n }\n\n function SelectLead($authToken)\n {\n $selectparam = [\n \"authToken\" => $authToken,\n \"selectQuery\" => \"SELECT Email FROM Lead WHERE Last_Name=Smith\",\n ];\n\n $url = sprintf(\"%s?%s\", \"https:\/\/www.cirrus-shield.net\/RestApi\/Query\", http_build_query($selectparam));\n $client = curl_init();\n\n curl_setopt($client, CURLOPT_VERBOSE, true);\n curl_setopt($client, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($client, CURLOPT_URL, $url);\n\n $response = curl_exec($client);\n curl_close($client);\n\n $array_data = json_decode($response, true);\n print_r('<pre>');\n var_dump($response);\n print_r('<\/pre>');\n return $response;\n }\n\n $username = \"mail@mail.com\";\n $password = \"password\";\n\n $authToken = authenticate($username, $password);\n $authToken = str_replace(\"\", \"\", $authToken);\n\n if ($authToken != '') {\n $selectLead = SelectLead($authToken);\n } else {\n echo \"<br>Authentication Failed\";\n } ?>\n\n<\/body>\n\n<\/html><\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
- Get the ID of the Organization<\/strong><\/li><\/ul>\n\n\n\n
You can get the ID of the Organization by sending the following query: “SELECT Id FROM Organization”<\/p>\n\n\n\n
This Query returns a record containing the ID of the Orgnization.<\/p>\n\n\n\n
Sample return data in JSON :<\/p>\n\n\n\n
{\u00ab Data \u00bb:{\u00ab Organization \u00bb:[{\u00ab Id \u00bb: \u00bb1453301944234805898\u2033}]}}<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
- Get the timezone of a user<\/strong><\/li><\/ul>\n\n\n\n
You can get the timezone of a user by sending the following query to the REST API :<\/p>\n\n\n\n
SELECT TimeZoneSidKey FROM User WHERE Username=user.name@company.com<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
This request returns a record that contains the timezone of the user. Here a sample return XML :<\/p>\n\n\n\n
<Data>\n <User>\n <TimeZoneSidKey>Europe_Paris<\/TimeZoneSidKey>\n <\/User>\n<\/Data><\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":944,"menu_order":9,"comment_status":"open","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"doc_tag":[],"class_list":["post-6450","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/6450","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/comments?post=6450"}],"version-history":[{"count":2,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/6450\/revisions"}],"predecessor-version":[{"id":6453,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/6450\/revisions\/6453"}],"up":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/944"}],"next":[{"title":"Important Notes","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/important-notess\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/6522"}],"prev":[{"title":"9. SendEmailWithAttachments","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/rest-api\/sendemailwithattachments\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/6517"}],"wp:attachment":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/media?parent=6450"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/doc_tag?post=6450"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}