V1

API change history

These APIs lets you use our message services from your applications.

Updates a given NKI question with the given information. NOTE! Existing information is replaced entirely with the new information set. NOTE! Updating question type from slider removes slider settings. NOTE! Updating question type to slider adds default slider settings.

Updates a given NKI question with the given information. NOTE! Existing information is replaced entirely with the new information set. NOTE! Updating question type from slider removes slider settings. NOTE! Updating question type to slider adds default slider settings.

Try it

Request

Request URL

Request parameters

  • integer

    Format - int32. Question ID

Request headers

  • (optional)
    string
    Media type of the body sent to the API.

Request body

Updated question data

{
  "ID": 0,
  "Question": "string",
  "HelpText": "string",
  "Type": 0,
  "Required": true,
  "Order": 0
}
{
  "description": "Data for updating an NKI question",
  "required": [
    "ID",
    "Question",
    "Type",
    "Required"
  ],
  "type": "object",
  "properties": {
    "ID": {
      "format": "int32",
      "description": "Question ID",
      "type": "integer"
    },
    "Question": {
      "description": "Question title/text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "HelpText": {
      "description": "Question help text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "Type": {
      "format": "int32",
      "description": "Question type",
      "maximum": 4,
      "minimum": 3,
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "type": "integer"
    },
    "Required": {
      "description": "Whether the question is mandatory",
      "type": "boolean"
    },
    "Order": {
      "format": "int32",
      "description": "Question order index in NKI",
      "type": "integer"
    }
  }
}
{
  "ID": 0,
  "Question": "string",
  "HelpText": "string",
  "Type": 0,
  "Required": true,
  "Order": 0
}
{
  "description": "Data for updating an NKI question",
  "required": [
    "ID",
    "Question",
    "Type",
    "Required"
  ],
  "type": "object",
  "properties": {
    "ID": {
      "format": "int32",
      "description": "Question ID",
      "type": "integer"
    },
    "Question": {
      "description": "Question title/text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "HelpText": {
      "description": "Question help text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "Type": {
      "format": "int32",
      "description": "Question type",
      "maximum": 4,
      "minimum": 3,
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "type": "integer"
    },
    "Required": {
      "description": "Whether the question is mandatory",
      "type": "boolean"
    },
    "Order": {
      "format": "int32",
      "description": "Question order index in NKI",
      "type": "integer"
    }
  }
}

Responses

200 OK

OK

Representations

{
  "NKI": 0,
  "ID": 0,
  "Question": "string",
  "HelpText": "string",
  "Type": 0,
  "Required": true,
  "Order": 0
}
{
  "description": "General question information",
  "required": [
    "ID",
    "Question",
    "Type",
    "Required"
  ],
  "type": "object",
  "properties": {
    "NKI": {
      "format": "int32",
      "description": "ID of parent NKI",
      "type": "integer"
    },
    "ID": {
      "format": "int32",
      "description": "Question ID",
      "type": "integer"
    },
    "Question": {
      "description": "Question title/text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "HelpText": {
      "description": "Question help text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "Type": {
      "format": "int32",
      "description": "Question type",
      "maximum": 4,
      "minimum": 3,
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "type": "integer"
    },
    "Required": {
      "description": "Whether the question is mandatory",
      "type": "boolean"
    },
    "Order": {
      "format": "int32",
      "description": "Question order index in NKI",
      "type": "integer"
    }
  }
}
{
  "NKI": 0,
  "ID": 0,
  "Question": "string",
  "HelpText": "string",
  "Type": 0,
  "Required": true,
  "Order": 0
}
{
  "description": "General question information",
  "required": [
    "ID",
    "Question",
    "Type",
    "Required"
  ],
  "type": "object",
  "properties": {
    "NKI": {
      "format": "int32",
      "description": "ID of parent NKI",
      "type": "integer"
    },
    "ID": {
      "format": "int32",
      "description": "Question ID",
      "type": "integer"
    },
    "Question": {
      "description": "Question title/text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "HelpText": {
      "description": "Question help text",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "Type": {
      "format": "int32",
      "description": "Question type",
      "maximum": 4,
      "minimum": 3,
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "type": "integer"
    },
    "Required": {
      "description": "Whether the question is mandatory",
      "type": "boolean"
    },
    "Order": {
      "format": "int32",
      "description": "Question order index in NKI",
      "type": "integer"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api.ip1sms.com/api/nkis/questions/{question}"
-H "Content-Type: application/json"

--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);

            // Request headers

            var uri = "https://api.ip1sms.com/api/nkis/questions/{question}?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // 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/api/nkis/questions/{question}");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json");


            // 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/api/nkis/questions/{question}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "PUT",
            // 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/api/nkis/questions/{question}";
    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:@"PUT"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // 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/api/nkis/questions/{question}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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 = {
    # Request headers
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.ip1sms.com')
    conn.request("PUT", "/api/nkis/questions/{question}?%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 = {
    # Request headers
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.ip1sms.com')
    conn.request("PUT", "/api/nkis/questions/{question}?%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/api/nkis/questions/{question}')


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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