---
swagger: "2.0"
info:
  version: 1.0.0
  title: CNSV-CTE-D-FacilityLocator
  description: This Service will cover the functionality for Facility Location using
    Google Maps API
  x-ibm-name: cnsv-cte-d-facilitylocator
  name: ""
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/consumer-services/facilities/searchByAddress:
    post:
      summary: Retrieve near by facilities using address
      description: This API is used to retrieve near by ATMs and Branches using address;
        The scope is public, post-login and entry-point
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - SearchByAddress
      parameters:
      - name: client_id
        in: header
        description: 'Client ID generated during application registration '
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: searchFacilityByAddressRequest
        in: body
        description: Request object for searching faciliies by address
        required: true
        schema:
          $ref: '#/definitions/SearchFacilityByAddressRequest'
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/SearchFacilityByAddressResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/consumer-services/facilities/searchByGeoLocation:
    post:
      summary: Retrieve near by facilities using geolocation
      description: This API is used to retrieve near by ATMs and Branches using geographic
        coordinates; The scope is public, post-login and entry-point
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - SearchByGeoLocation
      parameters:
      - name: client_id
        in: header
        description: 'Client ID generated during application registration '
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: searchFacilityByGeoLocationRequest
        in: body
        description: Request object for searching faciliies by geoLocation
        required: true
        schema:
          $ref: '#/definitions/SearchFacilityByGeoLocationRequest'
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/SearchFacilityByGeoLocationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  SearchFacilityByAddressRequest:
    type: object
    description: Request object for searching facilities using address
    required:
    - searchAddressText
    - searchRadius
    - facility
    properties:
      searchAddressText:
        type: string
        description: Any combination of address' attributes, e.g. street name, city,
          postal code, etc.
        example: Santa Fe
      searchRadius:
        type: integer
        description: Search radius in meters
        example: 1000
      searchDay:
        type: string
        description: Day of the week the facility has to be available
        example: MONDAY
        enum:
        - MONDAY
        - TUESDAY
        - WEDNESDAY
        - THURSDAY
        - FRIDAY
        - SATURDAY
        - SUNDAY
      searchTime:
        type: string
        description: Time the facility has to be available
        example: 09:00
      topFiveLocationSearchFlag:
        type: boolean
        description: Flag to retrieve the top five locations
        example: false
      nextStartIndex:
        type: string
        description: Next start index value
        example: ""
      facility:
        $ref: '#/definitions/Facility'
  SearchFacilityByGeoLocationRequest:
    type: object
    description: Request object for searching facilities using geoLocation
    required:
    - searchRadius
    - facility
    properties:
      searchRadius:
        type: integer
        description: Search radius in meters
        example: 1000
      searchDay:
        type: string
        description: Day of the week the facility has to be available
        example: MONDAY
        enum:
        - MONDAY
        - TUESDAY
        - WEDNESDAY
        - THURSDAY
        - FRIDAY
        - SATURDAY
        - SUNDAY
      searchTime:
        type: string
        description: Time the facility has to be available
        example: 09:00
      topFiveLocationSearchFlag:
        type: boolean
        description: Flag to retrieve the top five locations
        example: false
      nextStartIndex:
        type: string
        description: Next start index value
        example: ""
      facility:
        $ref: '#/definitions/FacilityInformation'
  SearchFacilityByAddressResponse:
    type: object
    description: Response object for searching facilities using address
    required:
    - facilities
    properties:
      facilities:
        type: array
        description: Facilities Information
        items:
          $ref: '#/definitions/FacilityDetails'
      nextStartIndex:
        type: string
        description: Next start index value
        example: CqQCEQEAADmTwFWl
  SearchFacilityByGeoLocationResponse:
    type: object
    description: Response object for searching facilities using geoLocation
    required:
    - facilities
    properties:
      facilities:
        type: array
        description: Facilities Information
        items:
          $ref: '#/definitions/FacilityDetails'
      nextStartIndex:
        type: string
        description: Next start index value
        example: CqQCEQEAADmTwFWl
  Facility:
    type: object
    description: Facility object used in the searchByAddress request
    required:
    - facilityType
    properties:
      facilityType:
        type: string
        description: Type of facility to search for
        example: ATM
        enum:
        - ATM
        - BRANCH
        - BOTH
  FacilityInformation:
    type: object
    description: Facility object used in the searchByGeoLocation request
    required:
    - facilityType
    properties:
      facilityType:
        type: string
        description: Type of facility to search for
        example: ATM
        enum:
        - ATM
        - BRANCH
        - BOTH
      geographicalLocation:
        $ref: '#/definitions/GeographicalLocation'
  FacilityDetails:
    type: object
    description: Facility object used in the response
    required:
    - facilityName
    - facilityType
    - fullAddress
    - availableTimes
    - geographicalLocation
    properties:
      facilityName:
        type: string
        description: Name of the facility
        example: citiBanamex Plaza El Punto
      facilityType:
        type: string
        description: Type of facility to search for
        example: BRANCH
        enum:
        - ATM
        - BRANCH
        - BOTH
      fullAddress:
        type: string
        description: The full address of the Facility as it appears on Google Maps
        example: Plaza El Punto, Blvd. Alfredo Del Mazo 727, Torres Científicos, Las
          Torres, 50120 Toluca De Lerdo, Mex
      availableTimes:
        type: string
        description: List of available times
        example: Lunes 9:00-16:00, Martes 9:00-16:00
      currentlyOpenFlag:
        type: boolean
        description: ' Indicates if the facility is currently open'
        example: true
      fullPhoneNumber:
        type: string
        description: Phone Number of the facility as it appears on Google Maps
        example: +52 55 1234 5678
      geographicalLocation:
        $ref: '#/definitions/GeographicalDetails'
  GeographicalLocation:
    type: object
    description: Geographical Location object in the request
    required:
    - latitude
    - longitude
    properties:
      latitude:
        type: string
        description: Latitude value for the geographical location where facility is
          located.
        example: "19.44841569999999"
      longitude:
        type: string
        description: Longitude value for the geographical location where facility
          is located.
        example: "-99.182073"
  GeographicalDetails:
    type: object
    description: Geographical Detail object in the response
    required:
    - latitude
    - longitude
    - photoUrl
    - placeId
    properties:
      latitude:
        type: string
        description: Latitude value for the geographical location where facility is
          located.
        example: "19.44841569999999"
      longitude:
        type: string
        description: Longitude value for the geographical location where facility
          is located.
        example: "-99.182073"
      photoUrl:
        type: string
        description: URL of the map
        example: https://maps.googleapis.com/maps/api/place/photo?maxwidth=100&photoreference
      placeId:
        type: string
        description: Id of the facility according to Google Maps
        example: ChIJvzI2eKT40YER81I9Z4ReZe4
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://api.banamex.com/mx-gcgapi
  type:
  - production
  - development
...