Vehicle Asset Finance Reference Data

Vehicle Asset Finance Reference Data 3.5.0

0
No votes yet

API used to supply reference data that is used throughout the Vehicle Asset Finance APIs

expand_moreexpand_lessContact information
Oertel, H. (Henry)
forum Discuss this API in the forum
production
https://api.nedbank.co.za/apimarket/sandbox

Paths

/cities/{region}

get /cities/{region}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
region
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

StringReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/cities/{region}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/cities/{region}
accept
region

/accounttypes

get /accounttypes
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/accounttypes
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/accounttypes
accept

/regions

get /regions
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

StringReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/regions
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/regions
accept

/statuses

get /statuses
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

ApplicationStatusIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/statuses
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/statuses
accept

/banks

get /banks
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/banks
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/banks
accept

/countries

get /countries
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/countries
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/countries
accept

/dealers/city/{filter}

get /dealers/city/{filter}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
filter
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

DealerCacheIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/dealers/city/{filter}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/dealers/city/{filter}
accept
filter

/dealers/region/{filter}

get /dealers/region/{filter}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
filter
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

DealerCacheIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/dealers/region/{filter}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/dealers/region/{filter}
accept
filter

/employmenttypes

get /employmenttypes
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/employmenttypes
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/employmenttypes
accept

/ethnicgroups

get /ethnicgroups
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/ethnicgroups
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/ethnicgroups
accept

/countries/{filter}/{exclude}

get /countries/{filter}/{exclude}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
filter
Required in path
string
exclude
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/countries/{filter}/{exclude}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/countries/{filter}/{exclude}
accept
filter
exclude

/financehouses

get /financehouses
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/financehouses
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/financehouses
accept

/industrytypes

get /industrytypes
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/industrytypes
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/industrytypes
accept

/instalmentsvariables

get /instalmentsvariables
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

StringObjectIDictionaryApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/instalmentsvariables
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/instalmentsvariables
accept

/vehicles/makes/{year}/{type}

get /vehicles/makes/{year}/{type}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
type
Required in path
string
year
Required in path
integer / int32
Accept
Optional in header
string
application/json
200

OK [Success]

StringReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/vehicles/makes/{year}/{type}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/vehicles/makes/{year}/{type}
accept
type
year

/maritalstatuses

get /maritalstatuses
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/maritalstatuses
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/maritalstatuses
accept

/vehicles/models/{year}/{type}/{make}

get /vehicles/models/{year}/{type}/{make}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
make
Required in path
string
type
Required in path
string
year
Required in path
integer / int32
Accept
Optional in header
string
application/json
200

OK [Success]

StringReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/vehicles/models/{year}/{type}/{make}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/vehicles/models/{year}/{type}/{make}
accept
make
type
year

/occupationtypes/{filter}

get /occupationtypes/{filter}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
filter
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/occupationtypes/{filter}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/occupationtypes/{filter}
accept
filter

/residentialstatuses

get /residentialstatuses
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/residentialstatuses
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/residentialstatuses
accept

/suburbs/{filter}

get /suburbs/{filter}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
filter
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

StringReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/suburbs/{filter}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/suburbs/{filter}
accept
filter

/titles

get /titles
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/titles
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/titles
accept

/vehicles/types

get /vehicles/types
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
Accept
Optional in header
string
application/json
200

OK [Success]

Int32ReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/vehicles/types
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/vehicles/types
accept

/dealers/name/{filter}

get /dealers/name/{filter}
Root
API Key
X-IBM-Client-Id
(apiKey located in header)
API Secret
X-IBM-Client-Secret
(apiKey located in header)
filter
Required in path
string
Accept
Optional in header
string
application/json
200

OK [Success]

StringReferenceIEnumerableApiResponse
default

Any HTTP returned code other than 200. Provider application specific error may be found in ResultSet

ResultSet
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/dealers/name/{filter}
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/reference/v3/dealers/name/{filter}
accept
filter

Definitions 

{
    "type": "object",
    "properties": {
        "errorCode": {
            "format": "int64",
            "type": "integer"
        },
        "errorMessage": {
            "type": "string"
        },
        "success": {
            "type": "boolean"
        }
    }
}
              
{
    "type": "array",
    "items": {
        "$ref": "#/definitions/Result"
    }
}
              
{
    "type": "object",
    "properties": {
        "additional": {
            "type": "object",
            "additionalProperties": {
                "type": "object"
            }
        },
        "code": {
            "type": "string"
        },
        "id": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "order": {
            "format": "int32",
            "type": "integer"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "code": {
            "type": "string"
        },
        "detail": {
            "type": "string"
        },
        "message": {
            "type": "string"
        },
        "name": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "data": {
            "$ref": "#/definitions/ArrayOfStringReference"
        },
        "metaData": {
            "$ref": "#/definitions/ResponseMetaData"
        }
    }
}
              
{
    "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"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "data": {
            "$ref": "#/definitions/ArrayOfInt32Reference"
        },
        "metaData": {
            "$ref": "#/definitions/ResponseMetaData"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "color": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "key": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "order": {
            "format": "int32",
            "type": "integer"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "data": {
            "$ref": "#/definitions/ArrayOfApplicationStatus"
        },
        "metaData": {
            "$ref": "#/definitions/ResponseMetaData"
        }
    }
}
              
{
    "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"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "data": {
            "$ref": "#/definitions/ArrayOfDealerCache"
        },
        "metaData": {
            "$ref": "#/definitions/ResponseMetaData"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "data": {
            "type": "object",
            "additionalProperties": {
                "type": "object"
            }
        },
        "metaData": {
            "$ref": "#/definitions/ResponseMetaData"
        }
    }
}
              
{
    "type": "array",
    "items": {
        "$ref": "#/definitions/StringReference"
    }
}
              
{
    "type": "array",
    "items": {
        "$ref": "#/definitions/Int32Reference"
    }
}
              
{
    "type": "array",
    "items": {
        "$ref": "#/definitions/ApplicationStatus"
    }
}
              
{
    "type": "array",
    "items": {
        "$ref": "#/definitions/DealerCache"
    }
}