V2

API change history

This is a project with the aim create an HTTP based API that is both powerful and simple to use.

Delete a survey template

Delete a survey template

Try it

Request

Request URL

Request parameters

  • string

Request body

Responses

200 OK

Survey template data

Representations

{
  "id": "string",
  "name": "string",
  "header": "string",
  "showQuestionHeader": true,
  "textAlignment": "Left",
  "backgroundColor": "string",
  "textColor": "string",
  "buttonColor": "string",
  "logotype": "string",
  "backgroundImage": "string",
  "useDisclaimer": true,
  "customDisclaimer": "string",
  "disclaimerLink": "string",
  "customEnding": "string",
  "endingLink": "string",
  "multipleLanguageSupport": true,
  "supportedLanguages": [
    "string"
  ],
  "baseLanguage": "string",
  "anonymousAnswers": true,
  "endDate": "string",
  "pinned": true,
  "lastModified": "string",
  "questions": [
    {}
  ],
  "translations": {}
}
{
  "required": [
    "anonymousAnswers",
    "backgroundColor",
    "baseLanguage",
    "buttonColor",
    "multipleLanguageSupport",
    "name",
    "pinned",
    "questions",
    "showQuestionHeader",
    "textAlignment",
    "textColor",
    "translations",
    "useDisclaimer"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "header": {
      "type": "string"
    },
    "showQuestionHeader": {
      "type": "boolean"
    },
    "textAlignment": {
      "enum": [
        "Left",
        "Center",
        "Right",
        "Justified"
      ],
      "type": "string"
    },
    "backgroundColor": {
      "type": "string"
    },
    "textColor": {
      "type": "string"
    },
    "buttonColor": {
      "type": "string"
    },
    "logotype": {
      "format": "uri",
      "type": "string"
    },
    "backgroundImage": {
      "format": "uri",
      "type": "string"
    },
    "useDisclaimer": {
      "type": "boolean"
    },
    "customDisclaimer": {
      "type": "string"
    },
    "disclaimerLink": {
      "type": "string"
    },
    "customEnding": {
      "type": "string"
    },
    "endingLink": {
      "type": "string"
    },
    "multipleLanguageSupport": {
      "type": "boolean"
    },
    "supportedLanguages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "baseLanguage": {
      "type": "string"
    },
    "anonymousAnswers": {
      "type": "boolean"
    },
    "endDate": {
      "format": "date-time",
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    },
    "lastModified": {
      "format": "date-time",
      "type": "string"
    },
    "questions": {
      "type": "array",
      "items": {}
    },
    "translations": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      }
    }
  },
  "example": "{\r\n  \"id\": \"string\",\r\n  \"name\": \"string\",\r\n  \"header\": \"string\",\r\n  \"showQuestionHeader\": true,\r\n  \"textAlignment\": \"Left\",\r\n  \"backgroundColor\": \"string\",\r\n  \"textColor\": \"string\",\r\n  \"buttonColor\": \"string\",\r\n  \"logotype\": \"string\",\r\n  \"backgroundImage\": \"string\",\r\n  \"useDisclaimer\": true,\r\n  \"customDisclaimer\": \"string\",\r\n  \"disclaimerLink\": \"string\",\r\n  \"customEnding\": \"string\",\r\n  \"endingLink\": \"string\",\r\n  \"multipleLanguageSupport\": true,\r\n  \"supportedLanguages\": [\r\n    \"string\"\r\n  ],\r\n  \"baseLanguage\": \"string\",\r\n  \"anonymousAnswers\": true,\r\n  \"endDate\": \"string\",\r\n  \"pinned\": true,\r\n  \"lastModified\": \"string\",\r\n  \"questions\": [\r\n    {}\r\n  ],\r\n  \"translations\": {}\r\n}"
}

404 Not Found

Survey template missing

Representations

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "format": "int32",
      "type": "integer"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}

Code samples

@ECHO OFF

curl -v -X DELETE "https://api.ip1sms.com/v2/surveys/templates/{id}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);


            var uri = "https://api.ip1sms.com/v2/surveys/templates/{id}?" + queryString;

            var response = await client.DeleteAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.ip1sms.com/v2/surveys/templates/{id}");


            URI uri = builder.build();
            HttpDelete request = new HttpDelete(uri);


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.ip1sms.com/v2/surveys/templates/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "DELETE",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.ip1sms.com/v2/surveys/templates/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"DELETE"];
    // Request headers
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.ip1sms.com/v2/surveys/templates/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_DELETE);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.ip1sms.com')
    conn.request("DELETE", "/v2/surveys/templates/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.ip1sms.com')
    conn.request("DELETE", "/v2/surveys/templates/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.ip1sms.com/v2/surveys/templates/{id}')


request = Net::HTTP::Delete.new(uri.request_uri)
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body