---
swagger: "2.0"
info:
  title: Vehicle Asset Finance Reference Data
  description: API used to supply reference data that is used throughout the Vehicle
    Asset Finance APIs
  contact:
    name: Oertel, H. (Henry)
    email: henryo@mfc.co.za
  version: 3.5.0
  x-swaggerversion: "1"
  x-swaggercreationdate: 14-05-2020
  x-ibm-name: vehicle-asset-finance-reference-data
  name: ""
host: tempuri.com
basePath: /vehicleassetfinance/reference/v3
schemes:
- https
paths:
  /cities/{region}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: region
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /accounttypes:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /regions:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /statuses:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/ApplicationStatusIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /banks:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /countries:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /dealers/city/{filter}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: filter
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/DealerCacheIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /dealers/region/{filter}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: filter
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/DealerCacheIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /employmenttypes:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /ethnicgroups:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /countries/{filter}/{exclude}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: filter
        required: true
        type: string
      - in: path
        name: exclude
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /financehouses:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /industrytypes:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /instalmentsvariables:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringObjectIDictionaryApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /vehicles/makes/{year}/{type}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: type
        required: true
        type: string
      - in: path
        name: year
        required: true
        type: integer
        format: int32
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /maritalstatuses:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /vehicles/models/{year}/{type}/{make}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: make
        required: true
        type: string
      - in: path
        name: type
        required: true
        type: string
      - in: path
        name: year
        required: true
        type: integer
        format: int32
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /occupationtypes/{filter}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: filter
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /residentialstatuses:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /suburbs/{filter}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: filter
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /titles:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /vehicles/types:
    get:
      tags:
      - Root
      produces:
      - application/json
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/Int32ReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
  /dealers/name/{filter}:
    get:
      tags:
      - Root
      produces:
      - application/json
      parameters:
      - in: path
        name: filter
        required: true
        type: string
      responses:
        200:
          description: OK [Success]
          schema:
            $ref: '#/definitions/StringReferenceIEnumerableApiResponse'
        default:
          description: Any HTTP returned code other than 200. Provider application
            specific error may be found in ResultSet
          schema:
            $ref: '#/definitions/ResultSet'
definitions:
  Result:
    type: object
    properties:
      errorCode:
        format: int64
        type: integer
      errorMessage:
        type: string
      success:
        type: boolean
  ResultSet:
    type: array
    items:
      $ref: '#/definitions/Result'
  StringReference:
    type: object
    properties:
      additional:
        type: object
        additionalProperties:
          type: object
      code:
        type: string
      id:
        type: string
      name:
        type: string
      order:
        format: int32
        type: integer
  ResponseMetaData:
    type: object
    properties:
      code:
        type: string
      detail:
        type: string
      message:
        type: string
      name:
        type: string
  StringReferenceIEnumerableApiResponse:
    type: object
    properties:
      data:
        $ref: '#/definitions/ArrayOfStringReference'
      metaData:
        $ref: '#/definitions/ResponseMetaData'
  Int32Reference:
    type: object
    properties:
      additional:
        type: object
        additionalProperties:
          type: object
      code:
        type: string
      id:
        format: int32
        type: integer
      name:
        type: string
      order:
        format: int32
        type: integer
  Int32ReferenceIEnumerableApiResponse:
    type: object
    properties:
      data:
        $ref: '#/definitions/ArrayOfInt32Reference'
      metaData:
        $ref: '#/definitions/ResponseMetaData'
  ApplicationStatus:
    type: object
    properties:
      color:
        type: string
      description:
        type: string
      key:
        type: string
      name:
        type: string
      order:
        format: int32
        type: integer
  ApplicationStatusIEnumerableApiResponse:
    type: object
    properties:
      data:
        $ref: '#/definitions/ArrayOfApplicationStatus'
      metaData:
        $ref: '#/definitions/ResponseMetaData'
  DealerCache:
    type: object
    properties:
      city:
        type: string
      dealerCode:
        type: string
      name:
        type: string
      phone:
        type: string
      region:
        type: string
      streetAddresss1:
        type: string
      streetAddresss2:
        type: string
      streetAddresss3:
        type: string
      streetAddresss4:
        type: string
      suburb:
        type: string
  DealerCacheIEnumerableApiResponse:
    type: object
    properties:
      data:
        $ref: '#/definitions/ArrayOfDealerCache'
      metaData:
        $ref: '#/definitions/ResponseMetaData'
  StringObjectIDictionaryApiResponse:
    type: object
    properties:
      data:
        type: object
        additionalProperties:
          type: object
      metaData:
        $ref: '#/definitions/ResponseMetaData'
  ArrayOfStringReference:
    type: array
    items:
      $ref: '#/definitions/StringReference'
  ArrayOfInt32Reference:
    type: array
    items:
      $ref: '#/definitions/Int32Reference'
  ArrayOfApplicationStatus:
    type: array
    items:
      $ref: '#/definitions/ApplicationStatus'
  ArrayOfDealerCache:
    type: array
    items:
      $ref: '#/definitions/DealerCache'
securityDefinitions:
  API Secret:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Secret
  API Key:
    type: apiKey
    name: X-IBM-Client-Id
    in: header
security:
- API Key: []
  API Secret: []
consumes:
- application/json
produces:
- application/json
x-ibm-configuration:
  enforced: true
  phase: realized
  testable: true
x-ibm-endpoints:
- endpointUrl: https://api.nedbank.co.za/apimarket/sandbox
  type:
  - production
...