OnStreet API v1

API change history

Restrictions_Cost

Calculates the cost for the given OSPs based on duration and entitlement type

Try it

Request URL

Request headers

string

A unique identifier for the user making the request

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "ospIds": [
    "string"
  ],
  "requestEndTime": "string",
  "requestStartTime": "string",
  "parkingEntitlementTypeIds": [
    0
  ],
  "vehicleManufactureYear": 0,
  "vehicleFuelType": 0
}
{
  "required": [
    "ospIds",
    "requestEndTime",
    "requestStartTime",
    "parkingEntitlementTypeIds",
    "vehicleManufactureYear",
    "vehicleFuelType"
  ],
  "type": "object",
  "properties": {
    "ospIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "requestEndTime": {
      "format": "date-time",
      "description": "End Time of the Parking Session",
      "type": "string"
    },
    "requestStartTime": {
      "format": "date-time",
      "description": "Start Time of the Parking Session",
      "type": "string"
    },
    "parkingEntitlementTypeIds": {
      "description": "Parking Entitlement Types Filter",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "vehicleManufactureYear": {
      "format": "int32",
      "description": "The year that the vehicle was manufactured. \r\nThis is used in cases in combination with <para name=\"VehicleFuelType\"></para>\r\nas there can be surcharges based on the combination of both",
      "type": "integer"
    },
    "vehicleFuelType": {
      "format": "int32",
      "description": "The vehicle fuel type\r\nThis is used in cases in combination with <para name=\"VehicleManufactureYear\"></para>\r\nas there can be surcharges based on the combination of both",
      "type": "integer"
    }
  }
}
{
  "ospIds": [
    "string"
  ],
  "requestEndTime": "string",
  "requestStartTime": "string",
  "parkingEntitlementTypeIds": [
    0
  ],
  "vehicleManufactureYear": 0,
  "vehicleFuelType": 0
}
{
  "required": [
    "ospIds",
    "requestEndTime",
    "requestStartTime",
    "parkingEntitlementTypeIds",
    "vehicleManufactureYear",
    "vehicleFuelType"
  ],
  "type": "object",
  "properties": {
    "ospIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "requestEndTime": {
      "format": "date-time",
      "description": "End Time of the Parking Session",
      "type": "string"
    },
    "requestStartTime": {
      "format": "date-time",
      "description": "Start Time of the Parking Session",
      "type": "string"
    },
    "parkingEntitlementTypeIds": {
      "description": "Parking Entitlement Types Filter",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "vehicleManufactureYear": {
      "format": "int32",
      "description": "The year that the vehicle was manufactured. \r\nThis is used in cases in combination with <para name=\"VehicleFuelType\"></para>\r\nas there can be surcharges based on the combination of both",
      "type": "integer"
    },
    "vehicleFuelType": {
      "format": "int32",
      "description": "The vehicle fuel type\r\nThis is used in cases in combination with <para name=\"VehicleManufactureYear\"></para>\r\nas there can be surcharges based on the combination of both",
      "type": "integer"
    }
  }
}

Response 200

OK

{
  "Data": {}
}
{
  "type": "object",
  "properties": {
    "Data": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "validUntil": {
            "format": "date-time",
            "description": "Cost is valid until\r\n<para>\r\nDateTime Utc\r\n</para>",
            "type": "string"
          },
          "totalCost": {
            "format": "int32",
            "description": "Total Calculated Cost",
            "type": "integer"
          },
          "parkingCost": {
            "format": "int32",
            "description": "Cost of Parking",
            "type": "integer"
          },
          "surcharge": {
            "format": "int32",
            "description": "Surcharge of Parking",
            "type": "integer"
          },
          "CashlessMerchantId": {
            "description": "Payment Merchant Id for the On Street Parking Item",
            "type": "string"
          },
          "MaxEndDateTime": {
            "format": "date-time",
            "description": "The maximum date time by which a parking session is valid for",
            "type": "string"
          },
          "MaxPaymentEndDateTime": {
            "format": "date-time",
            "description": "the maximum date time for which a parking session is chargeable",
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "Data": {}
}
{
  "type": "object",
  "properties": {
    "Data": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "validUntil": {
            "format": "date-time",
            "description": "Cost is valid until\r\n<para>\r\nDateTime Utc\r\n</para>",
            "type": "string"
          },
          "totalCost": {
            "format": "int32",
            "description": "Total Calculated Cost",
            "type": "integer"
          },
          "parkingCost": {
            "format": "int32",
            "description": "Cost of Parking",
            "type": "integer"
          },
          "surcharge": {
            "format": "int32",
            "description": "Surcharge of Parking",
            "type": "integer"
          },
          "CashlessMerchantId": {
            "description": "Payment Merchant Id for the On Street Parking Item",
            "type": "string"
          },
          "MaxEndDateTime": {
            "format": "date-time",
            "description": "The maximum date time by which a parking session is valid for",
            "type": "string"
          },
          "MaxPaymentEndDateTime": {
            "format": "date-time",
            "description": "the maximum date time for which a parking session is chargeable",
            "type": "string"
          }
        }
      }
    }
  }
}

Response 400

Response 401

Response 403

Rate limit or quota exceeded

{
  "StatusCode": 0,
  "Message": "string"
}
{
  "type": "object",
  "properties": {
    "StatusCode": {
      "format": "int32",
      "type": "integer"
    },
    "Message": {
      "description": "Indicates which quota has been exceeded and when it will be replenished",
      "type": "string"
    }
  }
}
{
  "StatusCode": 0,
  "Message": "string"
}
{
  "type": "object",
  "properties": {
    "StatusCode": {
      "format": "int32",
      "type": "integer"
    },
    "Message": {
      "description": "Indicates which quota has been exceeded and when it will be replenished",
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.appyparking.com/onstreet/v1/restrictions/cost"
-H "X-User-Id: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--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
            client.DefaultRequestHeaders.Add("X-User-Id", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.appyparking.com/onstreet/v1/restrictions/cost?" + 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.PostAsync(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.appyparking.com/onstreet/v1/restrictions/cost");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("X-User-Id", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // 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.appyparking.com/onstreet/v1/restrictions/cost?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-User-Id","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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.appyparking.com/onstreet/v1/restrictions/cost";
    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:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"X-User-Id"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // 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.appyparking.com/onstreet/v1/restrictions/cost');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'X-User-Id' => '',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'X-User-Id': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.appyparking.com')
    conn.request("POST", "/onstreet/v1/restrictions/cost?%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
    'X-User-Id': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.appyparking.com')
    conn.request("POST", "/onstreet/v1/restrictions/cost?%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.appyparking.com/onstreet/v1/restrictions/cost')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['X-User-Id'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# 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