V32 Third Party Interface Documentation-Complete (HTTP)

0
Xiamen Dashou Technology Ltd. V32 third party interface

Technology Limited documentation - complete (HTTP).
docx
Xiamen Dashou Technology Ltd.
V32 system third-party

interface documentation
Document No.: DS-
SC-C-34 Edition Ben:
V1.0
Entry into force :21 January 2019

Change of Change
Seria date of Change Version
l content of
numbe person
r
1 2018-10 Create a document Duan V1.0
Chun
-30
Wave
wave
2 2019-02 Modify document new V1.1
query order interface Jiang
-25 Gui
Dragon
Duan Audit
Prepa Chunbo Approva
ratio l
n
1
Xiamen Dashou Technology Ltd. V1.0 V32 third-party
Technology Limited interface
V32 third-party
interface
documentation
2016-9-18
Number Date Version Description Author

1 2016-09-18 1.0 Create a Duan
document Chunbo
2 2017-09-28 1.1 Increased Duan
heartbeat events Chunbo
1 / 46
2
Directory
Access Guide............................................................................ 5
API call method...................................................................... 6

1. Call flow:..................................................................................................................................... 6
2. HTTP URL composition:.....................................................................................................................6
3. Signature method:....................................................................................................................... 6
4. examples:..................................................................................................................................... 6
Common parameters.................................................................. 7
Return value............................................................................ 7
API list.......................................................................................... 7
1. Field library information class interface................. 8
1) Find field library (garage/find)...........................................................8
2) Access to yard static information (garage/info)...................................9
3) Access to Yard Dynamic Information (garage/dynamic)..................... 9
4) Details of Parking Ticket Type (garage/coupon_detail).................... 11
5) Availability of parking tickets (garage/coupon_validity).................. 11
6) Get details of multi-car rental type (garage/monthly_detail)...........12
7) Access to staggered parking spaces (garage/shared_lots)............... 13
8) Access to monthly rental account status (garage/monthly_state).... 14
2. Classified billing interface......................................... 15
1) Hourly Parking Charge (charge/hourly)........................................... 15
2) Scheduled billing (charge/reserve).................................................. 16

2 / 46
3
3) Monthly Rent Date New Charge (charge/monthly_new)................. 17
4) Extension of Monthly Rent (charge/monthly_extend)...................... 18
5) Charge for parking at wrong time (charge/rent)............................... 19
3. Ordering Interface..............................................................19
1) (order/hourly)............................................................................... 19
2) Purchase of parking tickets (order/coupon_buy).............................. 21
3) Access to parking tickets (order/coupon).......................................... 22
4) (order/prepaid_new)....................................................................23
5) (order/prepaid_recharge)............................................................ 24
6) Booking (order/reserve)................................................................ 25
7) (order/monthly_new)................................................................... 25
8) Extension of Monthly Rent (order/monthly_extend)...................... 26
9) Parking at wrong time (order/rent).................................................. 27
10) Establish sharing time (order/share_lot)......................................28
11) Confirmation of Order (order/confirm).........................................29
12) Control Command (order/control)............................................... 29
13) Credit Authorization (order/credit_give)..................................... 30
14) Enquiry Orders (order/query)......................................................... 30
4. Event Subscription..............................................................31
1) Event Subscription (event/subscribe).............................................. 31
Booking Fee Event (ReserveEvent)......................................................32
Date and Month Rent New Event (MonthlyNewEvent)..................... 32
Date Monthly Rent Extension (MonthlyExtendEvent)........................ 32

2 / 46
4
(PrepaidNewEvent)............................................................................. 32
Storage recharge event (PrepaidRechargeEvent).............................. 32
Event on using parking tickets (CouponUseEvent)............................. 32
Accidental parking (ShareParkEvent)................................................. 32
2) Heartbeat (HeartBeat) parameters.............................................. 32
3) Approach event (InEvent) response parameters:........................... 33
4) Departure Event (OutEvent) Response Parameters..................... 33
5) Booking Payment Event (ReserveEvent) Response Parameters... 34
6) Current Rent Payment Event (HourlyPayEvent) Response Parameters 35
7) Date and month rent new event (MonthlyNewEvent) response parameters

35
8) Date Monthly Rent Extension Event (MonthlyExtendEvent) Response

Parameters.................................................................................. 36
9) (PrepaidNewEvent) Response Parameters.................................. 36
10) stored value recharge event (PrepaidRechargeEvent) response parameter

37
11) Response parameters using parking ticket event (CouponUseEvent) 37
12) Error parking event (ShareParkEvent) response parameter...... 38
13) APP vehicle locked event response parameter........................... 38
14) APP vehicle unlocked event response parameter....................... 38
15) CreditPaymentEventResponseParameters....................................................................39
16) ExportQuotationEventResponseParameters.................................................................. 39
Remark:1.0Theexitquotationeventisviadepartureevent(departuretypetype=124)
Pushpush................................................................................................ 40
2 / 46
5
17) Event Query (event/query)...................................... Wrong!Nobookmarksaredefined.
5. Electronic invoice..............................................................40
1) Electronic invoice (einvoice /new).................................................... 40
2) Check the electronic invoice (einvoice /show).................................... 40
Certificate type.................................................................. 42
City List................................................................................ 42
Error code.............................................................................. 42
Access Guide
1. Access to APPKey and APPSecret
To contact customer service, register third party information, and obtain
exclusive APPKey and AppSecret, of the
2 / 46
6
APPKey and AppSecret are unique as third party callers, please keep them
properly
2. V32 interface only supports UTF-8 encoding, if the customer is in another encoding
format, please convert to UTF-8 request
3. V32 interface currently provides only HTTP REST API calls
4. V32 interface currently only supports json response formats
API call method
1. Call flow:
V32API is called based on HTTP protocol, and developers need to encapsulate

HTTP requests according to the protocol, roughly divided into the following
processes: populating parameters -> generating signatures -> encapsulating
HTTP requests - initiating requests
-> HTTP response -> analytical results
2. H TTP URL composition:
API the full url=base_url/v1/method ;base_url of the interface for Big Hand url;v1
represents the interface version; method is the method name provided in the list below,
such as (garage/find)
3. Signature method:
a) Eliminate null and sign parameters

b) In a set of parameters, the first character's key value ASCII the
code increment is sorted according to the value of the first
character (not the value corresponding to the parameter), and if the
same character is encountered, the second character's key value ASCII
the code increment is sorted, and so on
c) Each parameter and its value are combined into a "parameter = parameter
value" format in the parameter set
d) Add AppSecret to the last string you got
e) The spliced strings are encoded by UTF-8 and summarized by MD5 algorithm (all
lowercase) to obtain sign.
4. Examples:
For example, find the depot (garage/find):

i. Determining parameters
a) Public parameter
appkey="123456"
time
appkey=14739582
6 / 46
7
83
b) Business parameters
lat=118.123511,
lnglat=24.47371
9
radius=1000
ii. Parameter sorting and splicing
If AppSecret=abcdefg：
appkey123456lat118.123511lng24473719radius1000time1473958283abcdefg
iii. Generated signature
Call Md5(appkey123456lat118.123511lng24.473719radius1000time1473958283)
6 / 46
8
abcdefg)
aa7993bc142470c7b711193637c 45903 results
iv. http：//~garage/find? of HTTP call parameters generated appkey=123456&
timeappkey=1473958283& latappkey=118.123511& lngappkey=24.473719&
radiusappkey=1000& signappkey=45903 aa7993bc142470c7b711193637c &
Common parameters
Calling parameters that must be passed in by any API is currently supported by:
Name of Parameter Type Whether or not Parameter Description
parameter
appkey string Yes APPKey allocated to
applications
sign string Yes Results of Signature
Algorithm
time long Yes Time stamp for
submission of request
Return value
The return values for all API in V32 open interface are in the following json format
{
"status"：0 successful; non-zero failure indicates error code
"result"： success result or
error description" detail"：
error details time"：
timestamp returned by result
}
The return values in the following API list are only described result, Please apply
the full return results.
API list
7 / 46
9
Remarks:
The parameters listed in the following list are
business parameters only, please add open parameters
when calling; if there is no special description, all
the time units in the interface are seconds and the
unit of amount is minutes.
7 / 46
10
1. Field library information class interface
1) Search field library

(garage/find) method:
GET ,POST
Description: Find the given center point
coordinates, all yard request parameters within a
given radius:
Parameters Type Whether or not Note
lat float Yes Central latitude
lng float Yes Longitude at the

centre
radius float Yes Find radius (m)
Response result: result array response

parameters of the structure are as
follows:
Parameters Type Note Remarks Return sample
gid int Yard Code Return value example:
name string Name of depot {status"：0}
addr string Garage address "result"：[2]
city int Number of cities 0：{ gid "：111100001"
description string Garage "name"：" parking A"

description
type "：1" addr "："
type int Type of yard 0 Non-
informationized Zhongshan Road 1"
yard
"city"：0
1 Information
yard "description"：
2 Open Net Pay "sdfadsf""lotsinfo"：

Depot
"dadfs""imid"：
3 Roadside Easy
"distance"：
Stick
lotsinfo string Parking space 111.046005"lat"：
description
118.123511"lng"：
distance float Distance Unit: m
24.473719
lat float First entry and
exit latitude
8 / 46
11
lng Float First entrance }-
longitude 1：{ gid "：12300001"
"name"：" parking B"
linktype "：1" addr "："
Zhongshan Road 2"
"city"：
0"description"：
"sdfa""lotsinfo"：
"dsfa""imid"：
"distance"：
113.046005"lat"：
118.123512"lng"：
24.473729
8 / 46
12
2) Method of obtaining yard static
information (garage/info):
GET ,POST
Request parameters:
gids[] int Yes Number of yards
gids=100001& gids=100002& gids=100003

follows:
gid int Yard Code {

"status"：
name string Name of depot 0,
"result"：[
addr string Garage address
{
city int Number of cities "gid"：20130000,
"name"：" Xiamen city
description string Brief parking lot ",
introduction to "addr"：" Kyushu
the yard
Commercial House ",
type int Type of yard 0 Non- type"：2,.
informationized "city"：0,
yard "description"："24 hours a
1 Information day
yard Time ",
2 Opened Net Pay "lotsinfo"：" ground solid
Depot positioning:
300",
3 Roadside Easy
Stick "notice"：" nothing ",
"rev_brief"：" nothing ",
lotsinfo string Parking space
"share_brief"：" nothing ",
description
"imid"：
notice string Field warehouse "1","lanes"
notification
：[
rev_brief string Booking brief {
"id"：190,
share_brief string Introduction to
Wrong Time "gid"：20130000,
"name"：
imid string IM Account
"1","image"：
lanes Object groups All access lists Entry and exit http://xmchengting.cn/EparkingWeb1.0/
type: "photo/148309123121030000.jpg",
{ 0 Mix 1 entrance "type"：0,
2 out "lng"：118.13238,
id：int entrance id Oral "lat"：24.491634,
"order"：0
gid：int yard code }
name：string ]
entrance }
Name of name ],
"time"：1486426762
type：int access type }
lat：float latitude
lng：float longitude
image：string Picture
Road
Diameter
order：int access
row
Order No.
9 / 46
13
}
3) Method of obtaining dynamic information

(garage/dynamic): GET ,POST
9 / 46
14
Technology Limited interface documentation
Request parameters:
gids=100001& gids=100002& gids=100003
plate string Yes License plate
Note: At least one license plate and

card number must be filled in.
ticket string No Certificate No.
ticket_type int No Certificate type
phone string No Owner's mobile number
reserve int No Is the number of available parking

spaces available 1 Yes
share int No Is the number of wrong parking
spaces available 1 0?
monthly int No Number of available monthly parking
spaces 1 is 0
coupon int No Access to Purchaseable Parking
Ticket Data 1 Yes
closing_time long No End time of staggered period less than
closing_time time
(Expired), the wrong time parking
space is not counted; do not pass
the server current time

follows:
total_lots int Total number {status"：0}

of spaces
"result"：[1]
hourly_lots Int Number of
hours 0:{
monthly_lots Int Monthly "gid"：100000
charters
"total_lots"：0
total_free Int Total spare
monthly_free Int "hourly_free"：0

Monthly Rent
Free "reserve_free"：0
hourly_free int Number of
"shared_free"：0
spare spaces
available "monthly_list"：[1]
reserve_free int Number of
0：{
spaces
available "serial"：
shared_free int Number of
1"name"：" Day
wrong parking
spaces Card" count"：10
monthly_list Object groups List of serial ： Monthly
}
{ Monthly Rent Rent Type Serial
"coupon_list"：[1]
serial：int Types Number
0：{
name：string Available name： Monthly
"$ name"："5 voucher "
count：int Rent Type Name
"price"：500
} count ： available
"count"：150
Quantity
}
coupon_list Object groups Parking name： Parking
} 10 / 46
{ voucher list Ticket Name
}
15
4) Parking Ticket Type Details (garage/coupon_detail)

Method: GET ,POST
Request parameters:
gids=100001& gids=100002& gids=100003

Mobile phones are available only for

public access
start_time long Yes Search Time Start Time
end_time long Yes End of Enquiry Period

follows:
serial int Number of {status"：0}

parking tickets
kind int Type of parking 0 vouchers "result"：[1]
ticket
1 time voucher 0:{
2 points voucher "gid"：100000
3 product sub- "serial":1

time voucher
value int Time-to-Time Amount (sub) "kind"：1
Value
Duration "value":500
(seconds)
price int Parking coupons (sub) "price":300
count int Number available "count":100
name string Name of voucher "$ name"："5 voucher "
validity string Validity 2016-01-01 "validity": "2016-01-01
00:00:00~2016-12-30 00：00：00~2016-12-30 23：59：59"
23:59:59 or after "business":""

purchase
30 days }
business string Merchants }
5) Parking ticket availability (garage/coupon_validity)

method: GET ,POST
Request parameters:
coupons[] string Yes Coupon Coupon String List

11 / 46
coupon string Coupon Series Return value example:

16
follows:
11 / 46
17
validity int Effectiveness 0 Effective {status"：0}
1 coupon error "result"：[2]
No 2 coupons 0:{
3 Start time "coupon"："123243"

error
4 junction time "validity":1
error
5 generation "msg"：" coupon error"
error
6 Voucher Type }
Error
7 Used 1:{
8 Expiration "coupon"："
9 Not available [G100000][B20141108135823][E20161113135823]
msg string Description [K0][S500][C1535][V32678]"]
"validity":0
"msg"：" effective"
6) Obtain details of multi-car rental type

(garage/monthly_detail) Method: GET ,POST
Request parameters:
gids=100001& gids=100002& gids=100003

email string No

follows:
serial int Monthly Rent {status"：0}

Type Serial
Number
name string Monthly Rent "result"：[1]
Type Name
type int 0 packet 0:{
1 "gid"：100000
2 Reserves "serial":1
3 packs "name"： date card
4 packs "type":0
count int Total number of "count":2
12 / 46
18
spaces available
monthly
desc string Fees, access "lots":[2]
control,
In midfield, 0:{
time, etc
Note id:1
lots object[] Parking name：" Solid Position 1"

available
12 / 46
19
{ }1
Name of id：int id ：
name：string parking {
spaces id:2
} name：" Solid Position 2"
"desc"：""
}
7) Method of obtaining staggered parking space
details (garage/shared_lots): GET ,POST
Request parameters:
gids=100001& gids=100002& gids=100003

email string No
start_time long No Query start time
end_time long No End of query

follows:
Parameters Type Note Return sample
Remarks
gid int Yard Return value example:
Code
count int Vehicles {
available "status"：0,
Number "result"：[
{
lots object[] Parking
"count"：1,
space
{
list
gid：(int) lot "gid"：5800000,
"lots"：[
id :(int) parking {
"gid"：5800000,
id
"lotid"：123,
lotname：(string) parking space name "lotname"：" test 161105",
"share_type"：0,
share_type：(int)0 bulk rent 1 full
"shared_array"：[
remark：(string) staggered charge {
"sid"：
description shared_array：(object 2186,
"start_time"：1478800751,
[]) shared period
"end_time"：1478811551,
{ "duration"：10800,
"type"：1
sid:(int)
},
strat_time： start time {
"sid"：
end_time：(long) end 2187,
"start_time"：1478873831,
13 / 46
time duration：(int) long
"end_time"：1478877431,
20
}
],
"share_type"：0
}
],
"time"：1478930541
}
8) Obtain monthly rental account status
(garage/monthly_state) method: GET ,POST
Request parameters:
gid int Yes Yard No.

phone string Yes Owner's mobile number
email string No
shared int No 1 get parking space sharing

information 0 do not get, default do
not get
Take
rent int No 1 Access parking space is leased
information 0 not obtained, default
Not available
strat_time long No Start time for query sharing
end_time long No End time for query sharing
pageno int No Page Page Page Page Page Page
per_count int No Number of pages

follows:
monthly_serial int Monthly Rent Return value example:

Type Serial {
Number
"status"：
monthly_name string Monthly Rent 0"result"：{
Type Name "balance"：0
monthly_desc string Description of "start_time"："2016-08-01 00：00：00"
Monthly Rent "end_time"："2017-02-01 00：00：00"
Type "lotid"：
kind int Monthly Rent 0-month rent 1"lotname"：
Classification "monthly_serial "：
2 monthly 1"kind"：0
rent "share_type"：0//0 rent 1 full rent
"shared_array"：
6. Lease by
mistake {"length"：1
"data"：[1]
255 No monthly
0：{
rent
"Sid"：133
balance int Savings
"start_time"：1481212800,
balance (sub)
"end_time"：1481234400,
lotid int id parking "duration"：21600,
lotname string Name of "type"：0
parking space }
start_time string Start time

"now_page"：0 14 / 46
end_time string Closing time "page_limit"：0
"page_count"：0
21
{ "all_count"：1
}
sid：int }
start_time：long start "rent_array"：[// leased period
{
Inter-agency sid： corresponding sharing id
start_time:
End of end_time：long
end_time:
Inter-agency }
],
duration： duration
"time"：1478930541
(seconds)
t y pe ：0
divisible 1 not
}
Segmentation
"now_page" current
page
"page_limit" per page
"page_count" total
number of pages
"all_count" records
Quantity
rent_array Object[] List of leased

slots
{
sid：int//
corresponding sharing
notes
Records
start_time：string lease
Start time
end_time：string lease
Closing time
2. Classified billing interface
1) Time-rent parking billing

(charge/hourly) method:
GET ,POST
Description: Request
parameters for parking
fee when calculating:
Note: At least
one license
plate and card
number must be
filled in
(the same below) 15 / 46

charge_time long No Charge time,

22
Response results: result are

structural response parameters
consisting of the following
parameters:
enter_time long Entry Time {
charge_time long Billing time "status"：0,
duration long Length of Unit (seconds) "result"：{

parking
"gid"：10000000,
sum Int Total parking Unit (sub)
"plate"：" Sue E1234S",
need_sum int Additional Unit (sub)
payments "ticket"：
paid_sum int Total paid Unit (sub)
"","ticket_type"：0,
paid_list object groups Paid list Type of payment:
"enter_time"：1478961583,
{ 128 Alipay
payments "charge_time"：1478962322,
time：long//
129 WeChat Pay "duration"：739,
payment time
130 UnionPay "sum"：100,
sum：int// interface payments
payments 131 100 interface "paid_sum"：0,
Amount payments "need_sum"：

160 cash payments
type：int// 0,"paid_list"：
payments 161 Traffic card
payments [],
Type
162 UnionPay cards
"coupon_list"：
}
163 Internal
[],"enter_image"：
memory card
payments "http://120.42.51.206:8888/4329449.jpg",
coupon_list object groups Parking
"rent present_type"：" license plate
tickets used
{ List of lists "," leaving_duration"：900"
time：long// use time },
value：int// era gold "time"：1478962314

Value }
type：int 0 agent 1
Time
code：string coupon
string
}
enter_image string Entry Picture
leaving_duration int Tolerance time

(seconds)
present_type string Type of
presence
2) Planned billing
(charge/reserve) method:
GET ,POST
Request parameters:
16 / 46
23
Note: At least
one license
plate and card
number must be
filled in
(the same below)

start_time long Yes Scheduled start

time
duration long Yes Duration of
reservation
lotid int No Parking space
number
16 / 46
24

parameters:
gid int Yard No. {
plate string License plate "status"：0,
ticket string Certificate "result"：{
ticket_type int Certificate type "gid"：100000,
start_time long Scheduled start "plate"：" Fujian D001A1",

time
"ticket"：
duration long Duration of seconds
reservation "","ticket_type"：
sum int Amount Subdivision
0,
lotid int Parking space Standby
"start_time"：1486437554,
number
charge_time long Billing time "duration"：3600,
"sum"：100,
"lotid"：0,
"charge_time"：148644154
},
"time"：1486437556
}
3) Monthly Rent Date New Charge
(charge/monthly_new) Method: GET ,POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

monthly_serial int Yes Monthly rent

type serial
number only
Can be date type

time
end_time long Yes Duration of
reservation
number
17 / 46
25
Ignore int No Permitted wrong
account can also
handle monthly
rent
0 Not allowed
parameters:
gid int Yard No. {
17 / 46
26
monthly_serial int Monthly Rent "plate"：" Sue E1234S",
Type Serial
Number "ticket"：
start_time long Start time "","ticket_type"：
end_time long Closing time 0,"monthly_serial"：1,
sum int Amount Subdivision "start_time"：1475251200,
lotid int Parking space Standby "end_time"：1477843199,

number
"sum"：20000,
lotname string Name of parking
space "lotid"：103,
charge_time long Billing time "lotname"：" fixed position 103",
"charge_time"：1475251503,
},
"time"：1478962314
4) Monthly Rent Date Extended Billing

(charge/monthly_extend) Method: GET ,POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

extended_time long Yes End of time

after extension
parameters:
gid int Yard No. {
monthly_serial int Monthly Rent "plate"：" Guangdong E5E965",

Type Serial
Number "ticket"：
start_time long Start time "","ticket_type"：
end_time long Original end 0,

time
18 / 46
27
extended_time long End of time "monthly_serial"：0,
after extension
"start_time"：1486101838,
"end_time"：1488521038,
charge_time long Billing time
"extended_time"：1488636298,
"sum"：560,
"charge_time"：1486431710
},
"time"：1486431710
18 / 46
28
5) Wrong parking billing
(charge/rent) method: POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

lotid int Yes
time_slots object[] Time frame
sid：int sharing id
start_time：long
end_time：long

parameters:
gid int Yard No. {
lotid int "plate"：" Fujian ATM436",
lotname string Name of parking "ticket"：

space
"","ticket_type"：
0,
time_slots object[]
"lotid"：3095,
{
"sum"：
sid：int sharing id
500,"rent_list"：
start_time：long
[],"charge_time"：
end_time：long
} 0,"lotname"：
charge_time long Billing time "test263"
},
"time"：1486438105
19 / 46
29
3. Ordering Interface
1) Time Rent (order/hourly)

Method: GET ,POST
Description: Request
parameters for payment
of temporary parking
fee:
19 / 46
30
Note: At least
one license
plate and card
number must be
filled in
(the same below)

charge_time long Yes Billing time,

from accounting
Return value of
fee interface
sum int Yes Amount paid
pcode int No Type of payment
128 Alipay
payment
129 WeChat Pay
130 UnionPay
Online
132 Parking
Wallet
phone string No Owner's mobile
number
owner string No Name of owner
ignore_in int No Whether to
ignore the
presence of the
vehicle, ignore
the presence of
the vehicle, even
if the parking
yard is not
present, can also
order
successfully.
0 Not ignored
1 Ignorance
Default is
ignored
business_order string No Third party
business order
number
consisting
Parameters of the
Type following Note Remarks Return sample
orderno string Order No. {

20 / 46
gid int Yard No. "status"：0,
plate string License plate "result"：{
ticket string Certificate No. "orderno"：

"316990000000100",
ticket_type int Certificate type
31
parameters:
20 / 46
32
paid_list object groups Paid list Type of payment: "paid_list"：[],
{ 128 Alipay "coupon_list"：[],
payment
time:long// "enter_image"："",
129 WeChat Pay
Time of payment "present_type"：
130 UnionPay
sum：int// "","leaving_duration"：15
Interface
amount paid Payment
},
type：int// 131 Bailian
"time"：1486397793
Interface
payment type Payment }
}
160 Cash
payments
161 Traffic card

payments
162 UnionPay Card

Payment
163 Internal
memory card
payments
coupon_list object groups Parking ticket

list used
{
time：long// use
time
Gold Value
in value：int// Age
type：int 0
generation
Gold Generation
1
code：
coupon
character
String
}
2) Purchase of parking tickets
(order/coupon_buy) method:
POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

21 / 46
33
serial int Yes Number of
coupons
count int Yes Number of
purchases
sum int Yes Total amount
pcode int No Type of payment
128 Alipay
payment
129 WeChat Pay
130 UnionPay
Online
phone string Yes Owner's mobile
number
email string No
Response result: result structure consisting of the following parameters
21 / 46
34
Response parameters:
gid int Yard Code "status"：0,
coupon_serial int Number of "result"：{

coupons
count int Number of "gid"：20130000,
purchases
sum Int Total amount Unit (sub) "orderno"："4093000000201",
business string Distributor "coupon_serial"：5,
price int Unit price Unit (sub) "count"：1,
coupon_list string[] Coupon String "price"：400,

List
"name"："2 a little time ticket ",
"business"："",
"sum"：400,
"coupon_list"：[
"[G20130000][B20161213165216][E2017
0213165218][K1][S360][C275][V00041]"
},
"time"：1486427952
3) Use of Parking Voucher

(order/coupon) Method:
POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

coupon string Yes Coupon Series

number
owner string No Owner

consisting
Parameters of the
22 / 46
plate string "result"：{
ticket string "gid"：20130000,

35
parameters:
22 / 46
36
orderno string Order No. "ticket"："",
phone string Yes Owner's mobile "ticket_type"：0,

number
owner string No Owner "orderno"："2742814500001",
coupon string Coupon string "coupon":

used
"[G20130000][B20161213165216][E2017
0213165218][K1][S120][C274][V28145]",
"phone"："",
"owner"：""
},
"time"：1486364628
4) New storage (order/prepaid_new)

methodology: POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

monthly_serial int Yes Monthly Rent Type

Serial Number
Must be stored
start_time long Yes Storage
effective start
time
end_time long Yes Storage
effective end
time
sum int Yes Value of stored
value
number
pcode int No Payment type

code
128 Alipay ,129
WeChat ,130
UnionPay online
lotid int Yes Parking space
number
business order
number
23 / 46
37
consisting
Parameters of the
parameters:
plate string "result"：{
ticket string "gid"：300001,
ticket_type int "plate"：" auspicious UIWIW8",
23 / 46
38
monthly_serial int Monthly Rent "ticket"："",
Type Serial
Number
start_time long Storage "ticket_type"：0,
effective start
time "orderno"："4310000100003",
end_time long Storage "start_time"：1484010031,

effective end
time "end_time"：4099737600,
sum string Amount held "sum"：6000,
lotid int Parking space "lotid"：
lotname string Name of parking 2763,"phone"："",

space
"owner"："",
phone string Owner's mobile
number "lotname"："#188"
owner string Owner },
"time"：1484010043
5) Storage recharge
(order/prepaid_recharge) method:
POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

sum int Yes Value of stored

value
number

code
128 Alipay ,129
For WeChat ,130
for UnionPay
online
business order
number
24 / 46
monthly_serial int Monthly Rent "result"：{

39
parameters:
24 / 46
40
"balance"：42000
},
"time"：1484016623
6) Scheduled
(order/reserve)
methodology:
GET ,POST
Note: The order must be confirmed within 5 minutes after
the order is ordered, otherwise the order will automatically
cancel the request parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)


time
duration long Yes Scheduled
duration seconds
sum int Yes Amount charged

number

code
128 Alipay ,129
WeChat ,130
UnionPay online
number
business order
number
parameters:
orderno string Order No.
gid int Yard Code
duration long Scheduled

duration seconds
25 / 46
41
sum int Amount charged
lotid int Parking space

number
lotname string Name of parking
space
7) Monthly Rent Date New
(order/monthly_new) Method:
POST
Request parameters:
Remarks: License
plate and card
number
25 / 46
42
At least one
must be filled in
(the same below)

monthly_serial int Yes Monthly Rent Type

Serial Number
Date Type
start_time long Yes Start time
end_time long Yes Closing time

number
number

code
128 Alipay ,129
For WeChat ,130
for UnionPay
online
business order
number
easy int No Turn off 1 Turn
on Simplified
mode; Simplified
mode: No need to
bind parking
Required Monthly
Rent Type
parameters:
monthly_serial int Monthly Rent "result"：{

Type Serial
"gid"：300001,
Number
start_time long Storage "plate"：" Min DVVVVV ",
effective start
"ticket"：
time
end_time long Storage "","ticket_type"：0,
effective end
time "orderno"："9350000100003",
lotname string Parking space "start_time"：1486433280,
lotid int Parking space "end_time"：1486865280,

number
26 / 46
43
owner string Owner "monthly_serial"：0,
phone string Owner's mobile "sum"：1400,

number "lotid"：2828,
sum int Amount
"phone"："18650003576",
"owner"："",
"lotname"："#6"
},
"time"：1486433298
}
8) Extension of Monthly Rent (order/monthly_extend)
26 / 46
44
Method:
POST
request
parameters:
Note: At least
one license
plate and card
number must be
filled in
(the same below)

extended_time long Yes End of time

after extension

number

code
128 Alipay ,129
For WeChat ,130
for UnionPay
online
business order
number
parameters:
ticket string Certificate No. "result"：{
gid int Yard Code "plate"：" Min DVVVVV ",
monthly_serial int Monthly Rent "ticket"："",

Type Serial
Number
extended_time long End of time "ticket_type"：0,
after extension
end_time long End of time "orderno"："9380000100002",
before extension
sum int Amount "end_time"：1486980540,
"extended_time"：1486865280,
27 / 46
45
"sum"：560
},
"time"：1486433520
9) Parking (order/rent)
method: POST
Request parameters:
Note: At least
one license
plate and card
number must be
filled in
27 / 46
46
(the same below)

number

number

code
128 Alipay ,129
WeChat ,130
UnionPay online
time_slots Object[] Yes List of selected
slots
{
sid：int
corresponding
sharing
id start_time：
long end_time：
long
}
business order
number
parameters:
gid int Yard Code
sum int Amount
time_slots Object[] List of
{ selected or
sid：int conflicting
corresponding
sharing periods
id start_time：
long end_time：
long
}
10) Set Share Time (order/share_lot)
Method: POST
Request parameters:
28 / 46
47
Note: At least
one license
plate and card
number must be
filled in
(the same below)

28 / 46
48
number
number
share_list Object[] Yes Share slots list
sid：int
corresponding
sharing
id start_time：
long end_time：
long
duration：long
duration type：int 0
separable 1
}
parameters:
gid int Yard Code {
lotid int Parking space "status"：0,

number
"result"：{
"gid"：300001,
"lotid"：3000
},
"time"：1486370131
}
11) Order Confirmation
(order/confirm) Method:
GET ,POST
Request parameters:
orderno string Yes Order No.

parameters:
12) control command

(order/control) method:
GET ,POST.
Request parameters:
29 / 46
49
Parameters Type Whether or Note
not
Note: At least one
license plate and card
number must be filled
in.
ctrltype int Yes Type of control
29 / 46
50
1APP opening 4 manual
opening 5
Manual lock 8 lock 9

unlock
site int Yes Entry and exit station
phone string No Cell phone number

parameters:
plate string License plate
ticket string Certificate No.
gid int Yard Code
13) Method of Credit Authorization

(order/credit_give): GET ,POST
Request parameters:
not
Note: At least one
license plate and card
number must be filled
in.
credit_sum int Yes Credit line
credit_type uint Yes Use of Credit
0 Absolute use (if
you exceed the quota,
ignore the full amount
charged separately)
1 (over quota)
only difference
received)
phone string No Cell phone number

parameters:
30 / 46
51
gid int Yard Code
14) Query Order (order/query)

Method: GET ,POST
Request parameters:
30 / 46
52
orderno string Yes Order No.
gid int Yes Yard Code

parameters:
ticket string Certificate
ticket_type Int Certificate type
duration long Length of

parking (seconds)
in_time string Charge time
order_time string Order time
real_pay Int Received (sub)
4. Event Subscription
1) Event Subscription
(event/subscribe) Method:
GET ,POST
Request parameters:
pushurl string Yes Accepting event

callbacks
url, null
indicates
unsubscribe
verify string No V32 the system
does not do any
processing, when
the event push
is sent to the
caller as is,
the caller can
check the push
event
combination
Legal nature
events string No Subscribe
events id,
multiple events
separated by
31 / 46
53
commas (null or
non-passed for
default
subscription
events)
2,3,5）
Response results:
When an event occurs, the server POST data in the specified format to the
pushurl, caller to determine the type of event based on the value of the
event in the accepted parameter. After receiving the push, the receiver must
respond HTTP Code 200, otherwise, the push will be considered a failure, and
then pushed again every 30 minutes for 24 hours
event string Event message body

verify string
Examples:
event ={ ctime "："2017-11-28" 14：00：43", "event"：10, "gid"：400000, "site"：
31 / 46
54
0, "opcode"：0, "eventtime"："2017-11-28 14：00：42", "serial"：41990, "type"：

192, "chargrule"：" standard fee ", "ttype"：0, "ticket"：null, "plate "：" Fujian
D12345", "coupontype "：6, "value "：600, "actuallysum "：600, "coupon "：null,
"orderno "："27090000600006"}&verify =123
event Even
ts
1 Heartbeat events (HeartBeat)
2 Entry Events (InEvent)
3 Appearance Events (OutEvent)
4 Booking Fee Event (ReserveEvent)
5 Event on Time Rent Fee (HourlyPayEvent)
6 Date and Month Rent New Event
(MonthlyNewEvent)
7 Date Monthly Rent Extension
(MonthlyExtendEvent)
8 (PrepaidNewEvent)
9 Storage recharge event
(PrepaidRechargeEvent)
10 Event on using parking tickets
(CouponUseEvent)
11 Accidental parking (ShareParkEvent)
12 APP vehicle locked event (LockEvent)
13 APP vehicle unlocked (UnlockEvent)
14 Credit Payment Events (CreditPayEvent)
124 Export quotation events
2) Heartbeat (HeartBeat) parameters

Parameters Type Note
event int Fixed equals 1
gid int Yard No.
ctime string Event time
total_lots int Total number of spaces
monthly_lots int Monthly charters
hourly_lots int Number of hours
free_total_lots int Total remaining parking

spaces
free_monthly_lots int Monthly rental of
remaining parking spaces
free_hourly_lost int Rental of remaining
parking spaces
32 / 46
55
site_status Object groups site_status"：[.
{site "：int // Site Number
name"：string// Site Name
type"：int //1 Entry 2 Exit
"status"：int //0 offline 1
32 / 46
56
Line
Note: This parameter is
empty when the gate
system is offline
Remarks :120 s heartbeat interval
3) Approach event (InEvent) response parameters:
gid int Yard No.
ttype int Certificate type
site int Entry Site

Number
opcode int Operator Number
eventtime string Entry Time
serial int Incoming Water

Number
type int Entry Type
64 Ticket
collection
65 Rent to enter
for card
collection
66 License
plate rent into
the market 4
packs monthly
rent into the
market 2
monthly rent
into the market
193 privileges
194 Manual
approach
imageurl string Entry Picture
total_lots int Total number of

spaces
free_total_lots int Total remaining

parking spaces
free_monthly_lots int Monthly rental
of remaining
parking spaces
33 / 46
57
free_hourly_lost int Rental of
remaining parking
spaces
lots_group int Location Number
4) Event (OutEvent) Response Parameters:

gid int Yard No.
33 / 46
58
site int Departure Site

Number
eventtime string Departure time
in_time string Entry Time
in_serial int Incoming Water

Number
serial int Departing Water
type int Type of

departure
64 Rent to leave
while reading
65 Rent to leave
while reading
card
66 Renting off
4 packs monthly
2 monthly rental
departures
192
abnormal
departure
193
privilege
departure
194 manual
release
imageurl string Leave the scene
park_duration int Stop time

seconds
money int Parking amount

spaces

parking spaces
of remaining
parking spaces
remaining parking
spaces
paid_sum int Paid
5) Event (ReserveEvent) Response parameters:

34 / 46
59
gid int Yard No.
site int Paid Site Number
eventtime string Time of payment
serial int Payment pipeline

number
type int Type of payment
pcode int Payment method
34 / 46
60
chargrule string Billing type
name
start_time string Scheduled start
time
duration long Duration of
reservation
sum long Amount paid (per
unit)
6) (HourlyPayEvent) Response parameters:

gid int Yard No.

number

name
duration int Length of

presence
actuallysum int Amount received
(units)
shouldsum int Amount due
(unit)
7) Date and month rent new event (MonthlyNewEvent) response parameters:

gid int Yard No.

number
35 / 46
61

name
start_time string Start time
35 / 46
62
end_time string Closing time
duration long Long seconds

(units)
(unit)
8) Date and month rent extension event (MonthlyExtendEvent) response parameters:

gid int Yard No.

number

name
extended_time string End of time
after extension
end_time string End of time
before extension
duration long Long seconds

(units)
(unit)
9) (PrepaidNewEvent) Response parameters:

gid int Yard No.
36 / 46
63
number

name
36 / 46
64
start_time string Storage
effective start
time
end_time string Storage
effective end
time
blance int Savings balance
(sub)
(units)
(unit)
10) A stored value event (PrepaidRechargeEvent) response parameter:

gid int Yard No.

number

name
blance int Savings balance
(sub)
(units)
(unit)
11) Response parameters using parking ticket event (CouponUseEvent):

gid int Yard No.
37 / 46
65
eventtime string Time spent

number
coupontype int Type of coupon
37 / 46
66
0 generation
gold 1 generation
value int Generations
actuallysum int Actual credits
coupon string Coupon Series
12) Error parking event (ShareParkEvent) response parameters:

gid int Yard No.
serial int Payment pipeline number
chargrule string Billing type name
start_time string The earliest start of the wrong

time period
end_time string Latest end of wrong time period
actuallysum int Amount received (units)
shouldsum int Amount due (unit)
lotid int Parking space number
13) A PP vehicle locked event response parameter

gid int Yard No.
site int Site Number
14) A PP vehicle unlocked event response parameter

38 / 46
67
gid int Yard No.
38 / 46
68
site int Site Number
15) Credit Payment Event Response Parameters

gid int Yard No.

number
credit_type int Use of Credit
0 Absolute ,1
offset
credit_sum int Credit lines
16) Export Quotation Event Response Parameters

event int Fixed to 124
gid int Yard No.
site int Quotation Site

Number
eventtime string Quotation time
in_serial int Incoming Water

Number
serial int Departing Water
park_duration int Stop time

seconds
money int Parking amount
paid_sum int Amount paid

spaces

parking spaces
39 / 46
69
of remaining
parking spaces
remaining parking
spaces
39 / 46
70
Remarks :1.0 The exit quotation event of the depot is pushed through the departure event
(departure type type=124)
5. Electronic invoice
1) Method of issuing electronic

invoices (einvoice /new):
GET ,POST
Request parameters:
not
charge_serial string Yes Charge Full Flow

Number (Date + Water
Flow Number)
Total Water Number)

recv_email string Yes Mailbox for receipt of
invoices
parameters:
gid int Yard Code
charge_serial string Full Water

Charge
recv_email string Mailbox for
receipt of
invoices
2) View electronic invoice (einvoice
/show) method: GET ,POST
Request parameters:
not
charge_serial string Yes Charge Full Flow

Number (Date + Water
Flow Number)
Total Water Number)

parameters:
gid int Yard Code
charge_serial string Full Water

Charge
einvoice string Invoice layout
file
base64 string
40 / 46
71
6. Unlicensed car
1） Unlicensed vehicle scan code

approach (scan/identify_in) method:
GET ,POST.
Request parameters:
not
plate string No License plate
ticket string No Certificate
40 / 46
72
in_time long No Entry time stamp

seconds
site int Yes Site
business string No Third party order

number
parameters:
plate int Yard Code
ticket string Full Water Charge
ticket_type string Mailbox for

receipt of
invoices
in_time long Entry time stamp
seconds
2） Unlicensed car scan code exit
(scan/identify_out) method:
GET ,POST.
Request parameters:
not
plate string No License plate
ticket string No Certificate
out_time long No Departure time stamp
site int Yes Site
business string No Third party order

number
parameters:
plate int Yard Code
ticket string Full Water Charge
ticket_type string Mailbox for

receipt of
invoices
out_time long Departure time
stamp
duration int Duration
41 / 46
73
sum int Amount
paid_sum int Amount paid
coupon_sum int Coupon Amount
int Length of coupon
coupon_durat
ion
41 / 46
74
Certificate type
0 No
vouche
r
1
Traffi
c card
2
UnionP
ay
Card
51
Intern
al
cards
102
Ticket
s
128 QR
Code
City List
City Number City Name
0 Shanghai
1 Xiamen
42 / 46
75
Error code
Error code Note

10001 System error
10002 Service not available
10003 Remote server error
10004 IP restrictions
10005 appeky authorization required
42 / 46
76
10006 Unsupported media types

10007 Parameter error, see the document for
details
10008 System busy
10009 Task timeout
10010 Illegal requests
10011 Access restrictions for application
interfaces
10012 Missing required parameters, see API
documentation for details
10013 Invalid parameter value, see API
document for details
10014 Interface not available
10015 HTTP METHOD requested is not supported,
please check for selection
Choose the right way to POST/GET
10016 IP request frequency exceeds ceiling
10017 User request frequency exceeding limit
20001 Monthly rent conflicts
20002 Conflict at fault
21101 No yard code
21102 The yard code has been used
21103 No access
21801 Non-monthly rental users
21901 Overlapping of time periods
21902 Time conflict, part of the time has
been leased
21903 No permissions
21904 Time does not exist
22101 Full position
22102 No opening of premises
22201 The vehicle was not present
22202 Vehicle information does not exist in
the gate system
22203 Vehicle information not found
22301 Monthly Rent Type Error
22302 No monthly rent type
22303 Wrong parking
22304 Time rent conflict
22305 Monthly rent type conflicts
22306 Vehicles were present
23101 No purchase authority
23102 Amount error
23201 Invalid coupons
23202 Expired
43 / 46
77
23203 Not available

23204 Amount error
23205 Over purchaseable
23501 Coupon String Error
23502 No coupons
43 / 46
78
23503 Start time error

23504 Expiration time error
23505 Voucher Value Error
23506 Voucher Type Error
23507 The coupon has been used
23508 The coupon has expired
23509 Number of coupons used
23601 Order not available
23602 Order in force
23603 Order cancelled over time
23604 Order number mismatch
24101 APPKey doesn't exist
25001 Control command error
25002 Site error
25003 Failure of gate execution
26001 Electronic invoice not opened in yard
26002 No payment records
Revised LOG：
10:24:13,29 November 2016
1. settings share time interface remove (share_list) return value
25 December 2016 11:29:00

1.garage/monthly_detail interface return value count converted to total number of rented spaces per month
2.charge/monthly_new interface added ignore parameters
7 February 2017 9:49:23

1.garage/dynamic interface pull back closing_time optional parameters
15 February 2017 9:29:47

1. add control command interface (order/control)
22 May 2017
1. add credit authorization operation (order/credit_give)
21 June 2017
1. add electronic invoice class interface
28 September 2017
1. add heartbeat events
12 October 2017
1.(order/hourly) interface adds ignore_in parameters, whether to ignore the presence of the vehicle, ignore
the presence of the vehicle, even if the yard is not present, the order can be issued successfully. Often used
to order retry
44 / 46
79
21 November 2017
1. event subscription interface, add events parameters
1 February 2018
Number of parameters added 1. business_order rental order interface
2. monthly rental date, monthly rental storage value, monthly rent extension, monthly
rent recharge, booking, wrong order interface are increased
business_order
parameters 14
September 2018
Add 4 manual gate and 5 manual gate 1. control interface to realize remote and
unconditional gate control
45 / 46

V32 Third Party Interface Documentation-Complete (HTTP)

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

V32 Third Party Interface Documentation-Complete (HTTP)

Uploaded by

Copyright:

Available Formats

0

Xiamen Dashou Technology Ltd. V32 third party interface

Xiamen Dashou Technology Ltd.

V32 system third-party

Document No.: DS-

SC-C-34 Edition Ben:

Entry into force :21 January 2019

Number Date Version Description Author

API call method...................................................................... 6

1. Field library information class interface................. 8

1) Find field library (garage/find)...........................................................8

2) Access to yard static information (garage/info)...................................9

3) Access to Yard Dynamic Information (garage/dynamic)..................... 9

4) Details of Parking Ticket Type (garage/coupon_detail).................... 11

5) Availability of parking tickets (garage/coupon_validity).................. 11

6) Get details of multi-car rental type (garage/monthly_detail)...........12

7) Access to staggered parking spaces (garage/shared_lots)............... 13

8) Access to monthly rental account status (garage/monthly_state).... 14

2. Classified billing interface......................................... 15

1) Hourly Parking Charge (charge/hourly)........................................... 15

2) Scheduled billing (charge/reserve).................................................. 16

3) Monthly Rent Date New Charge (charge/monthly_new)................. 17

4) Extension of Monthly Rent (charge/monthly_extend)...................... 18

5) Charge for parking at wrong time (charge/rent)............................... 19

2) Purchase of parking tickets (order/coupon_buy).............................. 21

3) Access to parking tickets (order/coupon).......................................... 22

8) Extension of Monthly Rent (order/monthly_extend)...................... 26

9) Parking at wrong time (order/rent).................................................. 27

10) Establish sharing time (order/share_lot)......................................28

11) Confirmation of Order (order/confirm).........................................29

12) Control Command (order/control)............................................... 29

13) Credit Authorization (order/credit_give)..................................... 30

14) Enquiry Orders (order/query)......................................................... 30

1) Event Subscription (event/subscribe).............................................. 31

Booking Fee Event (ReserveEvent)......................................................32

Date and Month Rent New Event (MonthlyNewEvent)..................... 32

Date Monthly Rent Extension (MonthlyExtendEvent)........................ 32

Storage recharge event (PrepaidRechargeEvent).............................. 32

Event on using parking tickets (CouponUseEvent)............................. 32

Accidental parking (ShareParkEvent)................................................. 32

2) Heartbeat (HeartBeat) parameters.............................................. 32

3) Approach event (InEvent) response parameters:........................... 33

4) Departure Event (OutEvent) Response Parameters..................... 33

5) Booking Payment Event (ReserveEvent) Response Parameters... 34

6) Current Rent Payment Event (HourlyPayEvent) Response Parameters 35

7) Date and month rent new event (MonthlyNewEvent) response parameters

8) Date Monthly Rent Extension Event (MonthlyExtendEvent) Response

9) (PrepaidNewEvent) Response Parameters.................................. 36

10) stored value recharge event (PrepaidRechargeEvent) response parameter

11) Response parameters using parking ticket event (CouponUseEvent) 37

12) Error parking event (ShareParkEvent) response parameter...... 38

13) APP vehicle locked event response parameter........................... 38

14) APP vehicle unlocked event response parameter....................... 38

17) Event Query (event/query)...................................... Wrong!Nobookmarksaredefined.

1) Electronic invoice (einvoice /new).................................................... 40

2) Check the electronic invoice (einvoice /show).................................... 40

API call method

V32API is called based on HTTP protocol, and developers need to encapsulate

2. H TTP URL composition:

a) Eliminate null and sign parameters

For example, find the depot (garage/find):

1. Field library information class interface

1) Search field library

lat float Yes Central latitude