moovexDocs

Get validation schema

Retrieve mapping defaults and validation rules for the selected module.

GET/{module}/data-upload/schema

Path Parameters

ParameterTypeDescription
modulestringTarget module (entity) for data upload Allowed: areas, drivers, vehicles, extra_services, services, attributes, locations, fares, rates, profiles, passengers, suppliers, shuttles, shifts, driver_shifts, blacklist_cards, reservations

Example Response

{
  "fieldsMapping": {
    "name": [
      "Full name"
    ],
    "date": [
      "Ride date"
    ]
  },
  "fieldsDefaults": {
    "country": "US"
  },
  "validationMapping": {
    "name": [
      {
        "type": "isString"
      }
    ],
    "date": [
      {
        "type": "isDate",
        "parameters": [
          "DD/MM/YYYY HH:mm"
        ]
      },
      {
        "type": "isString"
      }
    ]
  },
  "dateFormatOptions": {
    "isDate": [
      "DD/MM/YYYY HH:mm"
    ],
    "isTimelessDate": [
      "DD/MM/YYYY"
    ],
    "isTime": [
      "HH:mm"
    ]
  }
}

On this page