Vai a daAaB INFO SOCIETARIE

daAaB API DEVELOPER PORTAL

Welcome to the daAaB developer portal!
Following, you will find all the calls that your web service will have to answer in order to integrate daAaB correctly.

daAaB requires all the information needed to link the travel solutions to the agency, and to include it among its partners.

daAaB requires a list of all the agency's stops.
It is necessary to provide name, code, latitude and longitude. Additional informations improve the user experience.

PARAMETERS

No parameters

RESPONSES

Code Model Example Value
200
[
{
stop_id*
string

stop_lat*
number

stop_lon*
number

stop_name*
string

stop_code
string

stop_descr
string

stop_url
string (url)

location_type
integer

parent_station
string

wheelchair_boarding
string

}
]
[
{
"stop_id": "ple_roma_01",
"stop_lat": 46.0345,
"stop_lon": 24.0345,
"stop_name": "Piazzale Roma, corsia A",
"stop_code": "ple_roma_01",
"stop_descr": "La fermata di Zitelle รจ situata nell'isola...",
"stop_url": "https://www.azienda.it/stop/ple_roma_01",
"location_type": 1,
"parent_station": "ple_roma_01",
"wheelchair_boarding": 0
}
]
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

daAaB requires a list of the shelf tickets that can be sold.
Shelf tickets are point-to-point tickets with predefined origin and destination, or fixed-price (for example, kilometrical). For each ticket you must necessarily provide code, price, name, description and expiration time in minutes (all other information can be added later).

PARAMETERS

No parameters

RESPONSES

Code Model Example Value
200
[
{
code*
string

price*
integer

currency_type
string

fare_type
string

name*
string

descr*
string

expire_minutes*
integer

}
]
[
{
"code": "ple_roma_01",
"price": 100,
"currency_type": "EUR"
"fare_type": "HOUR",
"name": "Urbano",
"descr": "Biglietto Urbano Mestre",
"expire_minutes": 90
}
]
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

Retrieves the needed ticket for a specific path.

daAaB requires the specific ticket needed for the journey on a specific route (providing also the eventual changes of vehicle).

PARAMETERS

Name Model Example Value
searchType
(body)
[ searchType
{
timestamp
string

steps*

}
]
{
"timestamp": 20180303121345,
"steps": [
{
"origin": "ple_roma_01",
"destination": "favaro"
}
]
}

RESPONSES

Code Model Example Value
200
[ ticket_info
{
code*
string

price*
integer

currency_type
string

fare_type
string

name*
string

descr*
string

expire_minutes*
integer

}
]
[
{
"code": "ple_roma_01",
"price": 100,
"currency_type": "EUR",
"fare_type": "HOUR",
"name": "Urbano",
"descr": "Biglietto Urbano Mestre",
"expire_minutes": 90
}
]
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

All the informations about the travel ticket (purchase, actvations, other info).

daAaB requires the emission of a specific ticket.

PARAMETERS

Name Model Example Value
ticketInfo
(body)
ticketRequest {
ticket*

steps

timestamp
string

}
{
"ticket": {
"code": "ple_roma_01",
"price": 100,
"start_at": "20180303121345",
"expire_at": "20180303121345",
"currency_type": "EUR",
"fare_type": "HOUR",
"name": "Urbano",
"descr": "Biglietto Urbano Mestre",
"expire_minutes": 90
}
"steps": [
"origin": "ple_roma_01",
"destination": "favaro"
}
"timestamp": 20180303121345
}

RESPONSES

Code Model Example Value
200
[ ticket
{
id*
string

code*
string

start_at
string

expire_at
string

qr_code
string

ticket
ticket_info {

code*
string

price*
integer

currency_type
string

fare_type
string

name*
string

descr*
string

expire_minutes*
integer

}
}
]
[
{
"id": "atvo_123456",
"code": "urbano_01",
"start_at": "20180303121345",
"expire_at": "20180303121345",
"qr_code": "20180303121345_atvo_123",
"ticket": {
"code": "ple_roma_01",
"price": 100,
"currency_type": "EUR",
"fare_type": "HOUR",
"name": "Urbano",
"descr": "Biglietto Urbano Mestre",
"expire_minutes": 90
}
}
]
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

daAaB confirms a previously issued ticket.

PARAMETERS

Name Description
id*
string
(path)
Your Ticket ID (Web Service ID)

RESPONSES

Code Model Example Value
200
boolean
true
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

daAaB actives a previously issued ticket.

PARAMETERS

Name Description
id*
string
(path)
Your Ticket ID (Web Service ID)

RESPONSES

Code Model Example Value
200
boolean
true
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

daAaB requires all the informations regarding a ticket previously issued.

PARAMETERS

Name Description
id*
string
(path)
Your Ticket ID (Web Service ID)

RESPONSES

Code Model Example Value
200
[ ticket
{
id*
string

code*
string

start_at
string

expire_at
string

qr_code
string

ticket

}
]
[
{
"id": "atvo_123456",
"code": "urbano_01",
"start_at": "20180303121345",
"expire_at": "20180303121345",
"qr_code": "20180303121345_atvo_123",
"ticket": {
"code": "ple_roma_01",
"price": 100,
"currency_type": "EUR",
"fare_type": "HOUR",
"name": "Urbano",
"descr": "Biglietto Urbano Mestre",
"expire_minutes": 90
}
}
]
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}

daAaB requires the informations to generate the ticket's QR code. This may be done statically, using a string containing all the necessary informations, or dinamically, following the instruction previously provided.

PARAMETERS

Name Description
id*
string
(path)
Your Ticket ID (Web Service ID)

RESPONSES

Code Model Example Value
200
[ ticket
{
id*
string

qr_code*
string

}
]
[
{
"id": "atvo_123456",
"qr_code": "20180303121345_atvo_123",
}
]
400
{
code*
integer

message*
string

}
{
"code": 4xx,
"message": "bad input parameters"
}
500
{
code*
integer

message*
string

}
{
"code": 5xx,
"message": "generic server error"
}