• Descrição: Calcula rotas entre uma origem e um destino.
• Nome do serviço na URL: obterrotas
• Parâmetros:
  • token: código de identificação do usuário.
  • origemMunicipio: município do endereço de origem.
  • origemNumero: número do endereço de origem (default = 1).
  • origemLogradouro: rua/avenida do endereço de origem.
  • destinoMunicipio: município do endereço de origem.
  • destinoNumero: número do endereço de origem (default = 1).
  • destinoLogradouro: rua/avenida do endereço de destino.
  • origemX: coordenada X(longitude) do ponto de origem.
  • origemY: coordenada Y(latitude) do ponto de origem.
  • destinoX: coordenada X(longitude) do ponto de destino.
  • destinoY: coordenada Y(latitude) do ponto de destino.
  • raioDeBusca: distância em metros da caminhada entre o ponto de origem e o ponto de embarque (default = 500, ou seja, 500 metros).
  • metodoOrdenacao: preferência de ordenação do resultado (default = 0). Os valores podem ser 0, 1, 2 ou 3, significando menor custo total (R$), menor distância percorrida (em quilômetros), menor caminhada (em metros), mínimo de transbordos, respectivamente.
  • preferencia: parseamento da string de vista da linha, ordenando o resultado por 'STRING%', onde STRING é o valor do parâmetro preferência.

Observação: A origem e o destino podem ser passados como endereço (rua, número, município) ou como ponto geométrico (longitude(x) e latitude(y)). Caso as duas maneiras sejam passadas por parâmetro, a forma de ponto geométrico será priorizada.

URL de requisição:

http://api.vadeonibus.com.br/VdoWS1.0/vdoconsulta/obterrotas?token=seutoken&origemX=-43.180046&origemY=-22.901162&destinoMunicipio=Rio%20de%20Janeiro&destinoLogradouro=Avenida%20das%20Americas&raioDeBusca=800&metodoOrdenacao=3

Retorno do web service:

{
    "listaRotaItem": [
        {
            "totalDinheiro": 3.80, // custo total do percurso utilizando dinheiro
            "totalCartao": 3.80,   // custo total do percurso utilizando o cartão bilhete único
            "pontoOrigem": {	// informações sobre o ponto de origem
                "lon": -43.180046,
                "lat": -22.901162,
                "logradouro": "Point(-43.180046 -22.901162)",
                "numero": "0",
                "referencia": "",
                "municipio": ""
            },
            "viagens": [	// Array de viagens desta opção. Uma viagem pode ser do tipo: caminhada, ônibus, trem, etc.
                {
                    "tipoDeTransporte": "Caminhada",
                    "distancia": 129,	// distância de caminhada em metros
			// string de polyline desta viagem do percurso
                    "polyline": "hzwjCdmpfGV`AZzA_AkEJl@WoAJ`@",
                    "pontoDestino": {	// ponto de destino do elemento viagem
                        "lon": -43.178825829127,
                        "lat": -22.900887853212,
                        "logradouro": "AVENIDA PRESIDENTE VARGAS",
                        "numero": "0",
                        "referencia": "(Ponto de referência: teste)",
                        "municipio": "Rio de Janeiro"
                    }
                },
                {
                    "tipoDeTransporte": "Ônibus",
                    "distancia": 31.37,		// distância do percurso de ônibus, em quilômetros
			// string de polyline desta viagem do percurso
                    "polyline": "pywjCtjpfGJ`@l@^XlAxA|GPz@Pr@|CfNLh@jArFzD~P`@bBvBpJXpA~BrKjBdIt@zETdA^dBt@lDDN^~AfBdIdAnEVbAh@dCh@hC~@dEx@vDtBdJdAtED^?P@TA`@C`@u@`FGtA?r@@J@R@NHp@H^DRDPFBHFLRZXNHRDH@N?JCNGFIJ[B]Hk@FSHYNW\\Ub@QXEVC`@@ZFzA^`APf@\\P@V@tA@tBB|BHtA?lAE`@jDF\\BNp@zCF^x@jCd@|AxAhFZ`A\\lANj@fB|FHRXhAvApEbAlDVv@h@tAtA`DBHp@|ABHh@lAb@lALZJXHXF^PfAFf@F~A?n@CjEA`@BdAB~@HbBHp@FPDZNj@Tt@Ld@t@hCpAbEj@lBTp@`@~@vB|Dp@pAhBrChC~DXd@jBvCTXv@~@`@^d@^jAt@`B`A|@h@l@ZzAr@XLz@f@~Ax@h@RlCnAj@XXPr@f@`A|@h@j@~@fAn@`ALRr@vARd@~@pC`@dAb@bAf@j@f@b@ZVJFLB~@t@xBnBn@n@f@h@~C|CjA|AtAzApB~B|@`Ah@j@nBrBxA~At@x@^^d@n@r@|@t@nARXRVb@p@h@`APVt@nAf@~@LZNX^xAfA|FJXDLPXd@b@d@d@nAbBZ`@RRVN\\JF@dCdARFr@Pr@LrAJjBRPDHDRNpAlA~@~@xAvATZVf@v@|BFT@JALEJKPc@r@??Wb@Yb@KNEHa@v@Yl@CL@h@DNLTRNt@d@b@TTHJBd@HbAD\\BLB~Bj@^NRLnAz@jA~@VRHPBL@H?VETINa@b@MRCP?H@HNd@FVFLFFND|CNtBFP?NARENGLINMPWJUBMBMJsB?]JkBASCWGM_@k@M[I[g@yCCMOYYYQUGICMAKDQFMDCFEFAL?J@JFFHBDDTD`AF`@Ll@Vz@Tf@NXnDnFzBdDdBpC\\`@zAtAdA~@JLHX@N?TYfBGf@B`@FVFPP\\RRjBdBHFLDN@NEFEFIDKBMF{A@IFIFEBCF?F?JBFBLNFLBNBPGxAAr@CJ?VEh@AR@XFj@FVTl@bAjBfAzBBFHb@Bb@?x@@JBHBHJJJDF@H?FAFAJKBG@G?O?GCOg@cBa@{AUiAGg@SsC?K@YBQL[L]|@_BLYRo@He@LSZWNENALDJHHLTp@V~@?ZAXIPONYN_@RWTQTKRCR?TFTNTh@l@NVT\\XZLRb@r@n@`@h@XFHLV`@j@RZJJLLPHn@^h@p@FV?J?JG^?H?TDRFPNPRPRJl@VLJDDFLDN@NANEVw@lBEV?TBV@JLf@BN?NAjA@LLh@`AnAf@`@ZPb@\\LLb@n@r@pAVd@hAdCPVHHTNvBx@f@XJFRTJRvAxDHPVZZPLDND~ANTDTHHDRJ\\L^Jb@HRJTFz@PXLTLPJJPDHFT@PBJDJLLb@VJJHLb@bADDPLTFN@LAXKXM\\WDAREL?JBb@J`@P\\R\\V`@`@LPVf@FX@Z?ZC`@?XDXJVZZNJx@XPRJL\\l@FRFZ@F?LCRGZAT?J@HDTr@vALJZNTFdAFHBFBDDDJFZFZFLHJ|C|BPRx@~@`CrCh@j@hAlAf@l@LXDTNlANf@FLHJTTjAn@vAfATLh@VRLDDLRHTBJj@hERfBLr@Pp@^z@JRJJXT|@^XPnA~@LHRHvAXn@RJDJFJFp@r@DFDJHt@@LBFFFJD|@RHFDFBFJl@DXLtABFB@H@HA@ADG@GKkD?e@@EDIHGDAJAJDDDBJAFCFKFILELAPBTFPZ~@JP`AlAPV~@fBZb@b@d@TRdC|APHRDTBb@DzADPBFBLHLJHN`AhDBP?JAJADEHg@|@IPQb@Ux@OTOLYJI@S?u@EM@ODIFGHk@hAORGFSLq@ZGBEDCFCL?JJ|@ALAJEHOPQNs@l@KJENAN@JFPBBHFFBH@N?HCHCt@cAzAcBBELGLEJAjESJ?PBXL`@\\dBpAZVFBJBR@JAHCv@a@HCFAJ?HBFDjAx@PTFPh@nCFVHNDDLJf@P`@V`@`@HHJFFBR?l@K~Bw@xBu@PERCZAZ?ZBZFdCj@p@Rb@L~IhDhEzAxBn@j@R|Bz@n@ZpDpBj@TZHTD\\B^@dG@zM@t@@p@CvA?`@EvIc@|AGp@Ez@Gn@I~@QpA_@l@MP?j@F`@JzDz@VCJCFEFMx@{CBM?OEOy@aBL_@HMHI^SHIJMHEJIHKp@cAh@mAlBsE^w@dHyP@KAIHOD[AICIGGK?GBMHEFGJER?JBD?JAHGFwFpDsAx@HRFPPp@DRJr@Dl@?~ACx@?F@DDFmBrEi@lAq@bAIJKHIDkBr@y@f@sAbAq@j@Y^QPQ^IJWNOFu@N_@@i@Ag@@}@L?VBDJPJH~@QpA_@l@MP?j@F`@JzDz@FBFFHJDHDX@t@DZIzDGfAUfBWrA]rBQ`AEt@E`A?tACzEAX??QnFOpCCl@Dv@HvCBjABZUlDOvAK`AMr@a@rBMl@]tAy@nCeAtBiAhCcAfDk@`B{AzEWp@]hAe@tAwAfFmAhEOp@_@jASt@O`@g@`BQl@e@zAgApD[hAKXg@|BQ|@In@UvBGbAE|ACpAEbBALCbAKzDGpAA\\_@xMCfAGrBAjACnBATGpBA`AIrPCfCCrACxDG~QGdIAzC@x@GrMA`BGtE?H?hCC`AAx@WlDAp@EnC?`IAbBC~E@fJAR",
                    "avisos": [
                        "Trajeto sem transbordo ou Ônibus Intermunicipal"
                    ],
                    "pontoDestino": {
                        "lon": -43.362338544236884,
                        "lat": -22.999424921534263,
                        "logradouro": "AVENIDA DAS AMERICAS",
                        "numero": "4002",
                        "referencia": "(Ponto de referência: Avenida Das Americas próximo ao 4002)",
                        "municipio": "Rio de Janeiro"
                    },
                    "linha": {	// informações sobre a linha de ônibus. Quando a viagem é do tipo caminhada, este campo não existe
                        "empresa": "Consórcio Transcarioca",
                        "tarifa": 3.8,
                        "municipio": "Rio de Janeiro",
                        "servico": "",
                        "vista": "345 - Barra da Tijuca - Candelária (via Furnas)",
                        "numero": "345",
                        "routeName": "",
                        "concessionaria": "",
                        "corconsorcio":"#6266ff"
                    },
                    "tempoViagem": 0,	// Tempo da viagem em minutos. Quando indisponível, tempoViagem será igual à zero.
                    "paradas": [	// Estações/paradas de ônibus durante o trajeto desta viagem
                        {
                            "referencia": "BRS 5A - RIO BRANCO",
                            "geometrico": {
                                "x": -43.178825829127,
                                "y": -22.900887853212
                            }
                        },
                        {
                            "referencia": "BRS 5A - RIO BRANCO",
                            "geometrico": {
                                "x": -43.179904285829,
                                "y": -22.901416534611
                            }
                        },
 
			// ... as outras paradas foram ocultadas neste exemplo
 
                        {
                            "referencia": "Avenida Das Americas próximo ao 4002",
                            "geometrico": {
                                "x": -43.362338544236884,
                                "y": -22.999424921534263
                            }
                        }
                    ]
                },
                {
                    "tipoDeTransporte": "Caminhada",
                    "distancia": 182,
                    "polyline": "pakkCretgGAj@QfAw@lB_@h@a@h@kD`Eg@`@k@x@Oj@G^C`@?d@??Df@D\\J`@Vf@h@r@|AhBtA|A~AlB^n@??b@n@Vh@Rj@Jf@Fv@@XJbO@rE@dC?tI@lABnH@nB@l@@lB@zBBvB@vA?nABtB?LDvK@jIBh@@^BdB@hDAf@ApC@PAfAA|@AtAE~CS`UAf@?lDAr@CnBCxC?d@Az@CzAEtBGdCAbDXxCF\\FlAKjEKfFIxGAbBCvCIbK?n@CdE@tB@hBBbCPvG\\xGVxDXtCRlBXdCb@dDn@jENt@VtA~@lEh@bCdCrKzCxMLd@hB`IlBlIfBnHh@lCNp@bAfF^xBvDzTjBfLtDdU??PjEj@fDb@nCtC`RFb@|@pFhCnPHb@TvA",
                    "pontoDestino": {
                        "lon": -43.452446933679404,
                        "lat": -23.01034490281672,
                        "logradouro": "Avenida das Americas",
                        "numero": "0",
                        "referencia": "",
                        "municipio": "Rio de Janeiro"
                    }
                }
            ]
        },
	// ... Os outros 4 itens de resultados foram ocultados neste exemplo
   ]
}

O Web service retornará um array(listaRotaItem), com no máximo 5 itens. Esses itens são as opções de rota. Cada item possui os seguintes atributos: totalDinheiro(float), totalCartão(float), pontoOrigem e um array de viagens.

O campo pontoOrigem possui as seguintes informações: longitude, latitude, logradouro, numero, referencia e municipio. Todos estes campos são referentes ao ponto de origem do percurso.

As viagens são os “pedaços” da opção de rota. As viagens podem ser do tipo: caminhada, ônibus, metro, barca e trem. Cada viagem possui os seguintes campos: tipoDeTransporte, pontoDestino, distancia, polyline, avisos, tempoViagem, paradas e linha. Viagens do tipo caminhada não possuem os campos avisos, tempoViagem, paradas e linha.