Phonixx Api

<back to all web services

Parkingaction

The following routes are available for this service:
PUT,OPTIONS/parking/active/promo/{Id}
GET,OPTIONS/parking/active/{Id}
GET,OPTIONS/parking/active/{OrderId}
GET,OPTIONS/parking/active

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/oneway/Parkingaction HTTP/1.1 
Host: parkmobile.us 
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	zone: 
	{
		zoneId: 0,
		internalZoneCode: String,
		signageCode: String,
		locationName: String,
		locationCode: 0,
		zoneInfo: 
		{
			tariffInfo: String,
			latitude: 0,
			longitude: 0,
			street: String,
			city: String,
			state: String,
			country: String,
			zipCode: String,
			capeLotId: 0,
			lotQuote: 
			{
				totalCost: String,
				pricingLines: 
				[
					{
						label: String,
						value: 0,
						type: String
					}
				],
				productId: 0,
				productStatus: String,
				currency: String,
				available: False,
				start: String,
				stop: String,
				hasInventory: False,
				hasEnoughSchedules: False,
				earlyBird: False,
				earlyBirdConditions: String,
				productMetafields: 
				[
					{
						id: 0,
						name: String,
						description: String,
						slug: String,
						createdAt: 0001-01-01,
						updatedAt: 0001-01-01,
						helpInfo: String,
						inputType: String,
						validValues: String,
						helpLinkName: String,
						helpDetails: String,
						required: False
					}
				],
				accessCodeUse: False
			},
			zoneEntranceImageUrl: String,
			hoursOfOperation: String,
			description: String,
			geometry: String
		},
		parkInfo: 
		{
			isStartDuration: False,
			isParkingAllowed: False,
			parkingNotAllowedReason: String,
			isPayBySpace: False,
			timeBlocks: 
			[
				{
					maximumValue: 0,
					minimumValue: 0,
					name: String,
					timeBlockType: String,
					timeBlockUnit: String,
					quantity: 0,
					isFixed: False,
					maxStopTimeLocal: String,
					priceInfo: 
					{
						merchantName: String,
						price: 
						{
							parkingPrice: 0,
							parkingVat: 0,
							parkingVatPercentage: 0,
							serviceFee: 0,
							serviceFeeVat: 0,
							serviceFeeVatPercentage: 0,
							showVat: False,
							totalPrice: 0,
							parkingPriceExVatAmount: 0,
							serviceFeeExVatAmount: 0,
							billingType: NotSet,
							externalCreditCardSource: String,
							parkingDiscount: 0,
							serviceFeeDiscount: 0,
							appliedDiscounts: 
							[
								String
							],
							billingMethodId: 0,
							membershipTypeId: 0
						},
						parkingStartTimeLocal: String,
						parkingStopTimeLocal: String,
						isParkingAllowed: False,
						parkingNotAllowedReason: String,
						maxParkingTime: 
						{
							hours: 0,
							days: 0,
							minutes: 0,
							totalMinutes: 0
						},
						parkingStartTimeUtc: String,
						parkingStopTimeUtc: String,
						timeZoneStandardName: String,
						cultureCode: String,
						currency: String,
						currencySymbol: String,
						hasPromoErrors: False,
						selectedPromoErrorMessage: 
						[
							String
						],
						hasAddPromoErrors: False,
						addPromoErrors: 
						{
							message: String,
							errorType: Undefined
						},
						masterPassPromoWillBeUsed: False,
						begin: String,
						end: String,
						isGroupParkingZone: False,
						prePaymentType: Immediate,
						policyLineItems: 
						[
							{
								policyId: 0,
								amount: 0,
								paidMinutes: 0
							}
						]
					},
					incrementValue: 0,
					timeblockId: 0
				}
			],
			hasDurationSelections: False,
			durationSelections: 
			{
				hasHourMinuteSelections: False,
				hourMinuteDurationSelections: 
				[
					{
						hour: 0,
						minutes: 
						[
							0
						]
					}
				],
				hasDaySelections: False,
				dayDurationSelections: 
				[
					0
				],
				selectionType: ShowBoth
			},
			paymentOptions: 
			{
				walletAccepted: False,
				creditCardTypesAccepted: 
				[
					String
				],
				paypalAccepted: False,
				chasePayAccepted: False,
				applePayAccepted: False,
				androidPayAccepted: False,
				masterpassStandardAccepted: False,
				masterpassV7Accepted: False,
				googlePayAccepted: False
			},
			maxParkingTime: 
			{
				hours: 0,
				days: 0,
				minutes: 0,
				totalMinutes: 0
			},
			spaceNumber: String,
			isRequireSpaceValidation: False,
			maxStopTimeLocal: String,
			maxStopTimeUtc: String,
			parkingNotAllowedFlag: Helpdesk,
			startTimeLocal: String,
			startTimeUtc: String,
			promotion: 
			[
				{
					promoCode: String,
					promoTitle: String,
					description: String,
					claimTimeUtc: String,
					startDate: String,
					endDate: String,
					discountType: String,
					infoUrl: String,
					validationConfirmMessage: String,
					showValidationConfirm: False,
					usageCount: 0,
					discountDetails: 
					[
						{
							discountUnit: String,
							discountValue: String,
							feeType: String
						}
					],
					internalZoneCode: String,
					addPromoErrors: 
					{
						message: String,
						errorType: Undefined
					},
					isValidation: False,
					parkingActionId: 0
				}
			],
			hasValidations: False,
			dayHourMinutesDurationSelections: 
			{
				dayHourMinuteDurationSelections: 
				[
					{
						day: 0,
						hourMinuteDuration: 
						[
							{
								hour: 0,
								minutes: 
								[
									0
								]
							}
						]
					}
				],
				selectionType: ShowBoth
			},
			hasDayHourMinutesDurationSelections: False,
			totalMaxParkingTime: 
			{
				hours: 0,
				days: 0,
				minutes: 0,
				totalMinutes: 0
			},
			isGroupParkingZone: False,
			accessCodeOption: NotAccepted,
			zoneDurationType: StartDuration
		},
		type: String,
		typeId: 0,
		garageImplementations: 
		[
			String
		],
		distanceMiles: 0,
		parkMobileSystem: 
		{
			id: 0,
			name: String
		},
		countryCode: String,
		gpsPoints: 
		[
			{
				longitude: 0,
				latitude: 0,
				description: String,
				city: String,
				street: String,
				isEntranceCoordinates: False,
				zoneGpsType: Zone
			}
		],
		sourceAppId: 0,
		restricted: False,
		supplierId: 0,
		supplierName: String,
		parkingActionType: OnDemand,
		startDate: String,
		endDate: String,
		zoneRedemptionInstructions: 
		[
			{
				sortOrder: 0,
				instruction: String,
				imageUrl: String
			}
		],
		zoneServices: 
		[
			{
				code: String,
				name: String,
				description: String,
				value: String
			}
		],
		zoneCustomImages: 
		[
			{
				customImageId: 0,
				s3Url: String
			}
		],
		isVehicleRequired: False,
		zoneClusterID: 0,
		accessCode: String,
		spaceNumber: String,
		isNewGarageImplementation: False
	},
	spaceNumber: String,
	startLocal: String,
	stopLocal: String,
	nowLocal: String,
	priceDetail: 
	{
		parkingPrice: 0,
		parkingVat: 0,
		parkingVatPercentage: 0,
		serviceFee: 0,
		serviceFeeVat: 0,
		serviceFeeVatPercentage: 0,
		showVat: False,
		totalPrice: 0,
		parkingPriceExVatAmount: 0,
		serviceFeeExVatAmount: 0,
		billingType: NotSet,
		externalCreditCardSource: String,
		parkingDiscount: 0,
		serviceFeeDiscount: 0,
		appliedDiscounts: 
		[
			String
		],
		billingMethodId: 0,
		membershipTypeId: 0
	},
	canStop: False,
	canExtend: False,
	car: 
	{
		vehicleId: 0,
		vrn: String,
		state: String,
		country: String,
		description: String,
		default: False,
		vehicleType: 
		{
			supplierVehicleTypeId: 0,
			vehicleTypeName: String
		},
		vin: String,
		gcid: String,
		vehicleMakeId: 0,
		make: String,
		model: String
	},
	timeZoneStandardName: String,
	startUtc: String,
	stopUtc: String,
	nowUtc: String,
	identifier: 
	{
		identityType: Rfid,
		number: String
	},
	masterId: 0,
	chargingCode: String,
	cultureCode: String,
	currency: String,
	currencySymbol: String,
	promoCode: String,
	selectedDiscounts: String,
	hasValidations: False,
	parkingActionType: OnDemand,
	isEarlyBird: False,
	mustEnterBeforeLocal: String,
	isCancelled: False,
	orderId: 0,
	eventName: String,
	eventStartDateLocal: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	eventStartDateUtc: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	eventEndDateLocal: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	eventEndDateUtc: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	venueAddress: 
	{
		addressLine1: String,
		addressLine2: String,
		city: String,
		state: String,
		country: String,
		zipcode: String
	},
	eventPackageName: String,
	eventId: 0,
	eventPackageId: 0,
	venueId: 0,
	venueName: String,
	eventParkingStartDateLocal: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	eventParkingStartDateUtc: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	eventParkingEndDateLocal: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	eventParkingEndDateUtc: 
	{
		value: String,
		year: 0,
		month: 0,
		day: 0,
		hour: 0,
		minute: 0,
		second: 0
	},
	gatedExternalUuid: String,
	maxStopTimeUtc: String,
	maxStopTimeLocal: String,
	reservationId: 0,
	reminder: None,
	reminderMinutes: 0
}