View All Methods in this API

returnScheduleSlots

Version 1 This method returns a list of all slots for a specific item or query.

https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots

For non required fields, you can either omit from the JSON string or set it to a default value
(e.g. String = "", Integer/Double = 0, Boolean = false, DateTime = 1900-01-01T00:00:00.000Z)

INPUT

Name Type Description Required
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "", "timezone_offset": 0, "auth_type": "", "system_name": "", "system_company_no": 0 }, "fields": {"auth_method": "", "slot_id": "", "slot_subject": "", "timezone_offset": 0, "api_username": "", "company_no": 0, "api_password": "", "includePast": false, "api_key": "", "schedule_slot_no": 0, "auth_type": "", "schedule_item_no": 0, "slot_start": "1/1/1900 12:00 AM", "username": "", "password": "", "slot_end": "1/1/1900 12:00 AM", "includeBooked": false, "slot_fee": 0, "includeSlots": false, "slot_quantity": 0, "system_name": "", "system_company_no": 0, "user_no": 0, "created_on": "1/1/1900 12:00 AM", "modified_on": "1/1/1900 12:00 AM" } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "fields": {"auth_method": "", "slot_id": "", "slot_subject": "", "timezone_offset": 0, "api_username": "", "company_no": 0, "api_password": "", "includePast": false, "api_key": "", "schedule_slot_no": 0, "auth_type": "", "schedule_item_no": 0, "slot_start": "1/1/1900 12:00 AM", "username": "", "password": "", "slot_end": "1/1/1900 12:00 AM", "includeBooked": false, "slot_fee": 0, "includeSlots": false, "slot_quantity": 0, "system_name": "", "system_company_no": 0, "user_no": 0, "created_on": "1/1/1900 12:00 AM", "modified_on": "1/1/1900 12:00 AM" } }

OUTPUT

By default, every API call returns an object of returnMessage as either XML or JSON depending on your content-type of the request.  With in the returnMessage structure the returnObject is specified above and differs based on the API meth.

Name Type Description
responseCode String This identifies the error that occurred for additional handling. Response codes starting with "A" are a success or "E" are an error.
message String Additional minor details on the response to display to your customers.
isError Boolean True if an error. False if succesful.
methodFailed String If there's an error, this is the method it failed at for debugging purposes.
extendedMessage String Additional instructions on how you can fix the error or what you can do with the return object.
reason String Explains why this error occurred or what was completed.
reponseTime Double How long it took to respond in seconds.
returnObject ArrayOfwi_schedule_slot
schedule_item_no double which schedule_item are you creating this slot for?
schedule_slot_no double (update) used to identify which item to update
slot_start dateTime what time does this slot start?
slot_end dateTime what time is this slot over?
slot_fee double If you charge to book
slot_id string used to identify repeating blocks
slot_quantity double how many slots are available?
slot_subject string provide a title for this slot
company_no double
created_on dateTime
modified_on dateTime
user_no double
includeBooked boolean
includeSlots boolean
{"responseCode": "", "message": "", "isError": false, "methodFailed": "", "extendedMessage": "", "reason": "", "responseTime": 0, "returnObject": [{"schedule_item_no": 0, "schedule_slot_no": 0, "slot_start": "1/1/1900 12:00 AM", "slot_end": "1/1/1900 12:00 AM", "slot_fee": 0, "slot_id": "", "slot_quantity": 0, "slot_subject": "", "company_no": 0, "created_on": "1/1/1900 12:00 AM", "modified_on": "1/1/1900 12:00 AM", "user_no": 0, "includeBooked": false, "includeSlots": false }] }

Sample Code

This sample code is to generate a function leveraging existing core functions you've already built.

                
func getAPIKit() -> (url: String, dict: Dictionary<String, AnyObject>) {

    var auth_method = ""
    var slot_id = ""
    var slot_subject = ""
    var timezone_offset = 0
    var api_username = ""
    var company_no = 0
    var api_password = ""
    var includePast = false
    var api_key = ""
    var schedule_slot_no = 0
    var auth_type = ""
    var schedule_item_no = 0
    var slot_start = "1/1/1900 12:00 AM"
    var username = ""
    var password = ""
    var slot_end = "1/1/1900 12:00 AM"
    var includeBooked = false
    var slot_fee = 0
    var includeSlots = false
    var slot_quantity = 0
    var system_name = ""
    var system_company_no = 0
    var user_no = 0
    var created_on = "1/1/1900 12:00 AM"
    var modified_on = "1/1/1900 12:00 AM"

    let url = "https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots"
    
    let key = "fields"
    let fieldsDict: Dictionary<String, AnyObject> = ["auth_method": auth_method, "slot_id": slot_id, "slot_subject": slot_subject, "timezone_offset": timezone_offset, "api_username": api_username, "company_no": company_no, "api_password": api_password, "includePast": includePast, "api_key": api_key, "schedule_slot_no": schedule_slot_no, "auth_type": auth_type, "schedule_item_no": schedule_item_no, "slot_start": slot_start, "username": username, "password": password, "slot_end": slot_end, "includeBooked": includeBooked, "slot_fee": slot_fee, "includeSlots": includeSlots, "slot_quantity": slot_quantity, "system_name": system_name, "system_company_no": system_company_no, "user_no": user_no, "created_on": created_on, "modified_on": modified_on ]
    let finalDict = User.getAuthDict(dictToAdd: fieldsDict, dictKey: key)
    
    return (url, finalDict)
  }

                
            

To get started we reccomend that you download the Alamofire project to simplify integration: https://github.com/Alamofire/Alamofire, in addition to SwiftyJSON: https://github.com/SwiftyJSON/SwiftyJSON

                
import Foundation

struct AUTH {
    static var api_username = <string>
    static var api_password = <string>
    static var api_key = <string>
    static var company_no = <double>
    static var username = <string>
    static var password = <string>
    static var timezone_offset = <double>
    static var auth_type = <string>
    static var system_name = <string>
    static var system_company_no = <double>}
    
struct FIELDS {
    static var auth_method = <string>
    static var slot_id = <string>
    static var slot_subject = <string>
    static var timezone_offset = <double>
    static var api_username = <string>
    static var company_no = <double>
    static var api_password = <string>
    static var includePast = <boolean>
    static var api_key = <string>
    static var schedule_slot_no = <double>
    static var auth_type = <string>
    static var schedule_item_no = <double>
    static var slot_start = <dateTime>
    static var username = <string>
    static var password = <string>
    static var slot_end = <dateTime>
    static var includeBooked = <boolean>
    static var slot_fee = <double>
    static var includeSlots = <boolean>
    static var slot_quantity = <double>
    static var system_name = <string>
    static var system_company_no = <double>
    static var user_no = <double>
    static var created_on = <dateTime>
    static var modified_on = <dateTime>}
    
func returnScheduleSlotsRequest() {
    
    var returnScheduleSlotsObjects = [AnyObject]()
    let postsEndpoint: String = "https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots"

    let authAndFieldsDict = ["auth": ["api_username": AUTH.api_username, "api_password": AUTH.api_password, "api_key": AUTH.api_key, "company_no": AUTH.company_no, "username": AUTH.username, "password": AUTH.password, "timezone_offset": AUTH.timezone_offset, "auth_type": AUTH.auth_type, "system_name": AUTH.system_name, "system_company_no": AUTH.system_company_no ], "fields": ["auth_method": FIELDS.auth_method, "slot_id": FIELDS.slot_id, "slot_subject": FIELDS.slot_subject, "timezone_offset": FIELDS.timezone_offset, "api_username": FIELDS.api_username, "company_no": FIELDS.company_no, "api_password": FIELDS.api_password, "includePast": FIELDS.includePast, "api_key": FIELDS.api_key, "schedule_slot_no": FIELDS.schedule_slot_no, "auth_type": FIELDS.auth_type, "schedule_item_no": FIELDS.schedule_item_no, "slot_start": FIELDS.slot_start, "username": FIELDS.username, "password": FIELDS.password, "slot_end": FIELDS.slot_end, "includeBooked": FIELDS.includeBooked, "slot_fee": FIELDS.slot_fee, "includeSlots": FIELDS.includeSlots, "slot_quantity": FIELDS.slot_quantity, "system_name": FIELDS.system_name, "system_company_no": FIELDS.system_company_no, "user_no": FIELDS.user_no, "created_on": FIELDS.created_on, "modified_on": FIELDS.modified_on ] ]

    Alamofire.request(.POST, postsEndpoint, parameters: authAndFieldsDict, encoding: .JSON).responseJSON { (request, response, data, error) in

      if let anError = error {

        println("error calling POST on /posts")
        println(error)

      } else if let jsonData: AnyObject = data {
        if let dataString = (jsonData.valueForKey("d") as! String).dataUsingEncoding(NSUTF8StringEncoding) {
            let json = JSON(data: dataString)  //use this object to parse data
            
            //SAMPLE PARSING
            let varData = json["returnObject"][0]["object"].stringValue

            // ----------
            // BELOW REPRESENTS AN EXAMPLE USING PURE SWIFT JSONSERIALIZATION INSTEAD OF SWIFTYJSON --------//

            //          if let returnScheduleSlotsDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
            //            if let returnObjectArray = returnScheduleSlotsDict["returnObject"] as? NSArray {
            //
            //              for returnScheduleSlotsObject in returnObjectArray {
            //                returnScheduleSlotsObjects.append(returnScheduleSlotsObject)
            //                if let item = returnScheduleSlotsObject["object_name"] as? NSDictionary {
            //                  let varItem = item["field_name"] as! String
            //                }
            //              }
            //
            //              println("\n\(returnScheduleSlotsObjects.count) Total")
            //            }
            //          }
        }
      }
    }
  }



            
<!DOCTYPE html>
<html>
<head>
<title>API Call - returnScheduleSlots</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 dataValue = {
         
            "auth": {
                "api_username": "", 
                "api_password": "", 
                "api_key": "", 
                "company_no": 0, 
                "username": "", 
                "password": "", 
                "timezone_offset": 0, 
                "auth_type": "", 
                "system_name": "", 
                "system_company_no": 0, 
                },
            
            "fields": {
                "auth_method": "", 
                "slot_id": "", 
                "slot_subject": "", 
                "timezone_offset": 0, 
                "api_username": "", 
                "company_no": 0, 
                "api_password": "", 
                "includePast": false, 
                "api_key": "", 
                "schedule_slot_no": 0, 
                "auth_type": "", 
                "schedule_item_no": 0, 
                "slot_start": "1/1/1900 12:00 AM", 
                "username": "", 
                "password": "", 
                "slot_end": "1/1/1900 12:00 AM", 
                "includeBooked": false, 
                "slot_fee": 0, 
                "includeSlots": false, 
                "slot_quantity": 0, 
                "system_name": "", 
                "system_company_no": 0, 
                "user_no": 0, 
                "created_on": "1/1/1900 12:00 AM", 
                "modified_on": "1/1/1900 12:00 AM", 
                },
            
      };
      
      $.ajax({
         url: 'https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots',
         type: 'POST',
         data: JSON.stringify(dataValue),
         contentType: 'application/json; charset=utf-8',
         dataType: 'json',
         error: function (XMLHttpRequest, textStatus, errorThrown) {
                alert("ERROR");
         },
         success: function (result) {
                var obj = JSON.parse(result.d).returnObject;

                $.each(obj, function(i) {
                    $("#divID").html(obj[i].field_name); //do something with the data
                })
         }
      })
   });
</script>
</body>
</html>
            
    
System.Net.HttpWebRequest req = System.Net.HttpWebRequest.Create("https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots");
req.Method = "POST";
req.ContentType = "application/json; charset=utf-8";

string dataValue = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },fields: {auth_method: <string>, slot_id: <string>, slot_subject: <string>, timezone_offset: <double>, api_username: <string>, company_no: <double>, api_password: <string>, includePast: <boolean>, api_key: <string>, schedule_slot_no: <double>, auth_type: <string>, schedule_item_no: <double>, slot_start: <dateTime>, username: <string>, password: <string>, slot_end: <dateTime>, includeBooked: <boolean>, slot_fee: <double>, includeSlots: <boolean>, slot_quantity: <double>, system_name: <string>, system_company_no: <double>, user_no: <double>, created_on: <dateTime>, modified_on: <dateTime> }}";

ASCIIEncoding encoding = new ASCIIEncoding();
byte[] bytes = encoding.GetBytes(dataValue);

req.ContentLength = bytes.Length;

System.IO.Stream strm = req.GetRequestStream();
strm.Write(bytes, 0, bytes.Length);
strm.Close();

System.Net.HttpWebResponse rsp = req.GetResponse();
System.IO.Stream data = rsp.GetResponseStream();
System.IO.StreamReader rdr = new System.IO.StreamReader(data);

string response = rdr.ReadToEnd();

Dim req As System.Net.HttpWebRequest = System.Net.HttpWebRequest.Create("https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots")
req.Method = "POST"
req.ContentType = "application/json; charset=utf-8"
        
Dim dataValue As String = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },fields: {auth_method: <string>, slot_id: <string>, slot_subject: <string>, timezone_offset: <double>, api_username: <string>, company_no: <double>, api_password: <string>, includePast: <boolean>, api_key: <string>, schedule_slot_no: <double>, auth_type: <string>, schedule_item_no: <double>, slot_start: <dateTime>, username: <string>, password: <string>, slot_end: <dateTime>, includeBooked: <boolean>, slot_fee: <double>, includeSlots: <boolean>, slot_quantity: <double>, system_name: <string>, system_company_no: <double>, user_no: <double>, created_on: <dateTime>, modified_on: <dateTime> }}"
        
Dim encoding As New ASCIIEncoding()
Dim bytes As Byte() = encoding.GetBytes(dataValue)
        
req.ContentLength = bytes.Length
        
Dim strm As System.IO.Stream = req.GetRequestStream()
strm.Write(bytes, 0, bytes.Length)
strm.Close()
        
Dim rsp As System.Net.HttpWebResponse = req.GetResponse()
Dim data As System.IO.Stream = rsp.GetResponseStream()
Dim rdr As New System.IO.StreamReader(data)

Dim response As String = rdr.ReadToEnd()
// 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://peoplevine.azure-api.net/customer/customer/registerCustomer");
      // Specify your subscription key
      builder.setParameter("subscription-key", "");
      URI uri = builder.build();
      HttpPost request = new HttpPost(uri);
      StringEntity reqEntity = new StringEntity("", ContentType.create("application/json"));
      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());
   }
  }
}
<?php

// This sample uses the HTTP_Request2 package. (for more information: http://pear.php.net/package/HTTP_Request2)
require_once 'HTTP/Request2.php';
$headers = array(
   'Content-Type' => 'application/json',
);

$query_params = array(
   // Specify your subscription key
   'subscription-key' => '',
);

$request = new Http_Request2('https://peoplevine.azure-api.net/customer/customer/registerCustomer');
$request->setMethod(HTTP_Request2::METHOD_POST);
// Basic Authorization Sample
// $request-setAuth('{username}', '{password}');
$request->setHeader($headers);

$url = $request->getUrl();
$url->setQueryVariables($query_params);
$request->setBody("");

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

?>

    #import <Foundation/Foundation.h>
    
    NSDictionary *authDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"api_username",
            <string>, @"api_password",
            <string>, @"api_key",
            <double>, @"company_no",
            <string>, @"username",
            <string>, @"password",
            <double>, @"timezone_offset",
            <string>, @"auth_type",
            <string>, @"system_name",
            <double>, @"system_company_no", nil];
    
    NSDictionary *fieldsDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"auth_method",
            <string>, @"slot_id",
            <string>, @"slot_subject",
            <double>, @"timezone_offset",
            <string>, @"api_username",
            <double>, @"company_no",
            <string>, @"api_password",
            <boolean>, @"includePast",
            <string>, @"api_key",
            <double>, @"schedule_slot_no",
            <string>, @"auth_type",
            <double>, @"schedule_item_no",
            <dateTime>, @"slot_start",
            <string>, @"username",
            <string>, @"password",
            <dateTime>, @"slot_end",
            <boolean>, @"includeBooked",
            <double>, @"slot_fee",
            <boolean>, @"includeSlots",
            <double>, @"slot_quantity",
            <string>, @"system_name",
            <double>, @"system_company_no",
            <double>, @"user_no",
            <dateTime>, @"created_on",
            <dateTime>, @"modified_on", nil];
    
    NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
                authDic, @"auth",fieldsDic, @"fields", nil];
 
    NSMutableDictionary* jsonString = nil;
    jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
    
    NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSString *urlString = @"https://api.peoplevine.com/scheduler.asmx/returnScheduleSlots";
    
    ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:[NSURL URLWithString:urlString]];    
    [request setTimeOutSeconds:250];    
    [request setRequestMethod:@"POST"];    
    [request addRequestHeader:@"Content-Type" value:@"application/json"];    
    [request addRequestHeader:[NSString stringWithFormat:@"%d",bodyData.length] value:@"Content-length"];    
    [request setPostBody:bodyData];    
    [request startSynchronous];

    NSDictionary *responseDic = (NSDictionary*)[request.responseString JSONValue];   
   
    if (responseDic || [responseDic objectForKey:@"d"])
    {
        NSMutableDictionary *dicSave=[responseDic objectForKey:@"d"];
        // -------------------------------------------------------------------
        // convert into the data and NSUTF8StringEncoding
        // -------------------------------------------------------------------
        NSString *strDic=[dicSave copy];
        NSMutableDictionary *dirJson;
        if (strDic)
        {
            NSData* dataFile=[strDic dataUsingEncoding:NSUTF8StringEncoding];
            NSString* newStr = [[NSString alloc] initWithData:dataFile
                                                     encoding:NSUTF8StringEncoding];
           
            dirJson = [newStr JSONValue] ;
        }
        // -------------------------------------------------------------------
        
        NSString *str=[[dirJson objectForKey:@"returnObject"]valueForKey:@"customer_no"];
    }
    else
    {
        UIAlertView *alert=[[UIAlertView alloc]initWithTitle:@"Error" message:@"An Error Occurred" delegate:nil cancelButtonTitle:@"Ok" otherButtonTitles:nil];
        [alert show];
    }
require 'net/http'

uri = URI('https://peoplevine.azure-api.net/customer/customer/registerCustomer')

uri.query = URI.encode_www_form({
   # Specify your subscription key
   'subscription-key' => '',
})

request = Net::HTTP::Post.new(uri.request_uri)

# Basic Authorization Sample
# request.basic_auth 'username', 'password'
request['Content-type'] = 'application/json'

request.body = ""

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

puts response.body
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',
}

params = urllib.urlencode({
   # Specify your subscription key
   'subscription-key': '',
})

try:
   conn = httplib.HTTPSConnection('peoplevine.azure-api.net')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", 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 = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',
}

params = urllib.parse.urlencode({
   # Specify your subscription key
   'subscription-key': '',
})

try:
   conn = http.client.HTTPSConnection('peoplevine.azure-api.net')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data = response.read()
   print(data)
   conn.close()
except Exception as e:
   print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
@ECHO OFF

REM for Basic Authorization use: --user {username}:{password}
REM Specify values for path parameters (shown as {...}), your subscription key and values for query parameters
curl -v -X POST "https://peoplevine.azure-api.net/customer/customer/registerCustomer?subscription-key="^
 -H "Content-Type: application/json"