tmsentregas

geocoding

44 views 07/11/2018 04/11/2019 integrador 0

2.0info: 1.10.1 geocoding x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: geocoding contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsentregassecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /geocoding/queries/geocode: post: description: Geocodificação de endereços. Utiliza Google Geocoding API. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: logradouro: type: string description: Logradouro numero: type: string description: Número bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado pais: type: string description: País cep: type: string description: CEP lat: type: string description: Latitude lon: type: string description: Longitude responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsAPI – latLong – endereco properties: ok: type: boolean description: Indicador de sucesso da operação. dsErro: type: string description: Mensagem de erro, caso ocorra. dsAPI: type: string description: Descrição de qual API geocodificou com sucesso: Nominatim Openstreetmap ou Google Geocoding API latLong: type: object allOf: – #/definitions/latLongRec description: Latitude e Longitude obtidas. endereco: type: object allOf: – #/definitions/enderecoRec description: Endereço default: description: Error response schema: #/definitions/genericError get: description: Geocodificação de endereços. Utiliza Google Geocoding API. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: logradouro description: Logradouro in: query type: string – name: numero description: Número in: query type: string – name: bairro description: Bairro in: query type: string – name: cidade description: Cidade in: query type: string – name: estado description: Estado in: query type: string – name: pais description: País in: query type: string – name: cep description: CEP in: query type: string – name: lat description: Latitude in: query type: string – name: lon description: Longitude in: query type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsAPI – latLong – endereco properties: ok: type: boolean description: Indicador de sucesso da operação. dsErro: type: string description: Mensagem de erro, caso ocorra. dsAPI: type: string description: Descrição de qual API geocodificou com sucesso: Nominatim Openstreetmap ou Google Geocoding API latLong: type: object allOf: – #/definitions/latLongRec description: Latitude e Longitude obtidas. endereco: type: object allOf: – #/definitions/enderecoRec description: Endereço default: description: Error response schema: #/definitions/genericError /geocoding/queries/geocodificaLote: post: description: Geocodificacao de lote de enderecos. Utiliza Google Geocoding API. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – enderecos properties: enderecos: type: array items: type: object allOf: – #/definitions/enderecoInputRec minimum: 1 description: Lista de Endereços a serem geocodificados. responses: 200: description: Ok schema: type: object required: – ok – erros – enderecosOk – enderecosNOk properties: ok: type: boolean description: Indicador de sucesso da operação. erros: type: array items: type: object allOf: – #/definitions/mensagemRec minimum: 1 description: Mensagens de erro, caso ocorram. enderecosOk: type: array items: type: object allOf: – #/definitions/enderecoOutputRec minimum: 1 description: Endereços geocodificados com sucesso enderecosNOk: type: array items: type: object allOf: – #/definitions/enderecoInputRec minimum: 1 description: Endereços não geocodificados default: description: Error response schema: #/definitions/genericError /geocoding/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /geocoding/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError definitions: userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT latLongRec: description: type: object required: – lat – lon properties: lat: type: number format: double description: lon: type: number format: double description: cep: type: string description: enderecoRec: description: type: object required: – logradouro – bairro – cidade – estado – pais – numero properties: logradouro: type: string description: bairro: type: string description: cidade: type: string description: estado: type: string description: pais: type: string description: numero: type: string description: enderecoInputRec: description: Dados para geocodificacao em lote type: object properties: cdAtividade: type: integer format: int64 description: Código da atividade associada ao endereço logradouro: type: string description: Logradouro numero: type: string description: Número bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado pais: type: string description: País cep: type: string description: CEP lat: type: string description: Latitude lon: type: string description: Longitude mensagemRec: description: Dados para retorno de mensagens do processamento type: object required: – dsMensagem properties: cdAtividade: type: integer format: int64 description: Código da atividade relacionada a operação realizada dsMensagem: type: string description: Descrição da mensagem de sucesso/erro/alerta enderecoOutputRec: description: Dados de rotorno da geocodificacao type: object properties: cdAtividade: type: integer format: int64 description: Código da atividade associada ao endereço processado logradouro: type: string description: Logradouro retornado pela API de Geocodificação numero: type: string description: Número retornado pela API de Geocodificação bairro: type: string description: Bairro retornado pela API de Geocodificação cidade: type: string description: Cidade retornado pela API de Geocodificação estado: type: string description: Estado retornado pela API de Geocodificação pais: type: string description: País retornado pela API de Geocodificação cep: type: string description: CEP retornado pela API de Geocodificação lat: type: number format: double description: Latitude retornada pela API de Geocodificação lon: type: number format: double description: Longitude retornada pela API de Geocodificação notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment