1. Service Logs
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
          GET
        • Retrieve a Service Log
          GET
        • Create a Service Log
          POST
        • Delete a Service Log
          DELETE
        • Update a Service Log
          PATCH
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Service Logs

Create a Service Log

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
POST
/api/v1/servicelogs
Creates a Service Log.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
servicelog
object 
required
service_date
string <date>
required
Date of the service log
vehicle_code
string 
required
Code/Plate Number of the vehicle
damage_type
enum<string> 
optional
Types of damage reported
Allowed values:
Tire BreakdownEngine FailureElectronic FailureOther Failure
notes
string 
optional
Additional Notes
base64_image
string 
optional
A string containing the file's contents encoded in Base64 format. This can represent various file types, such as images, PDFs, or other documents.
Example
{
    "servicelog": {
        "service_date": "2024-08-14",
        "vehicle_code": "L23EXM07",
        "damage_type": "Electronic Failure",
        "notes": "ApiExample"
        
    },
    "base64_image": "Base64EncodedFileExample"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo.modaltrans.com/api/v1/servicelogs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "servicelog": {
        "service_date": "2024-08-14",
        "vehicle_code": "L23EXM07",
        "damage_type": "Electronic Failure",
        "notes": "ApiExample"
        
    },
    "base64_image": "Base64EncodedFileExample"
}'

Responses

🟢201Created
application/json
Body
Service logs for vehicles
array of:
uuid
string <uuid>
required
Unique identifier for the service log
notes
string 
required
Notes about the service performed
damage_type
enum<string> 
required
Types of damage reported
Allowed values:
Tire BreakdownEngine FailureElectronic FailureOther Failure
vehicle_code
string 
required
Code/Plate Number identifying the vehicle
service_date
string <date>
required
Date when the service was performed
Example
[
    {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "notes": "string",
        "damage_type": "Tire Breakdown",
        "vehicle_code": "string",
        "service_date": "2019-08-24"
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-29 12:08:34
Previous
Retrieve a Service Log
Next
Delete a Service Log
Built with