|    Oxmaint API Documentation

Getting Started with Oxmaint API

Welcome to the Oxmaint API Documentation! Our API provides you with seamless access to manage and automate your Oxmaint entities, such as work orders, maintenance requests, assets, and more. Whether you're looking to integrate Oxmaint into your internal systems or build custom applications, our API allows you to do just that.

How to Generate an API Key

Follow these steps to generate an API key:

• Log in to your Oxmaint account.
• Navigate to Settings > API Keys.
• Click on Create New Key and give it a meaningful name.
• Copy the generated API key and securely store it. You’ll need this key for making authenticated requests.

Using Postman to Test Your Requests

1. Download and install Postman if you haven't already.
2. Create a new environment with the following variables:
• baseUrl: https://api.oxmaint.com/{cilent_id}/v1
• bearerToken: Your generated API key
3. Include the Authorization header in your requests:

   Authorization: Bearer {bearerToken}

Authentication

Every request to the Oxmaint API must include your API key as a Bearer Token in the Authorization header:

Authorization: Bearer {API_KEY}

Contact Information

Email: contact@oxmaint.com
Phone: +1 (315) 888-1995
Website: https://www.oxmaint.com/

POST: Create a Work Order

This API creates a new work order with all necessary details, including tasks, parts, labor, remarks, attachments, and additional costs.

Overview

This endpoint allows you to create a new work order in the Oxmaint system.

Endpoint

POST https://api.oxmaint.com/{cilent_id}/v1/workorders

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the work order.
  Example: "1727310792675"
• masterEmail (string, required): The email associated with the master account.
  Example: "oxmainti@gmail.com"
• workOrderNumber (string, required): The work order number.
  Example: "WO1033"
• title (string, required): The title of the work order.
  Example: "Demo"
• status (string, required): The status of the work order.
  Example: "Initiated"
• priority (string, required): Priority of the work order.
  Example: "High", "Medium", "Low"
• type (string, required): Type of the work order.
  Example: "General", "Repair"
• assetNumber (string, required): Asset number associated with the work order.
  Example: "21-B-02 B"
• assetName (string, required): The name of the asset.
  Example: "Boiler 2"
• assetModel (string, required): The model of the asset.
  Example: "AJAX-Model WEG-2500"
• dates.dueDate (string, required): The due date for the work order.
  Format: YYYY-MM-DD HH:MM:SS
• dates.startDate (string, required): The start date for the work order.
  Format: YYYY-MM-DD HH:MM:SS
• dates.createdDate (string, auto-generated): The created date for the work order.
• tasks (array of objects, required): Array of task objects related to the work order. Each task contains:
  • taskId (string): Unique identifier for the task.
  • taskName (string): The name of the task (e.g., "Change Oil").
  • taskStatus (string): The status of the task (e.g., "Initiated", "Completed").
  • taskType (string): The type of task (e.g., "Repair").
  • assignedTo (object, optional): The person assigned to the task.
  • taskNote (string, optional): Notes related to the task.
  • dates (object, required): Dates related to the task.
• parts (array of objects, required): Array of part objects used in the work order. Each part contains:
  • partId (string): Unique identifier for the part.
  • itemNumber (string): SKU or item number.
  • itemName (string): Name of the part (e.g., "Oil Filter").
  • partNumber (string): Part number (e.g., "1R-1807").
  • quantity (integer): Quantity of the part.
  • unit (string): Unit of measurement.
  • itemCost (number): Cost of the item.
  • note (string, optional): Additional notes.
• labor (array of objects, required): Array of labor objects related to the work order. Each labor entry contains:
  • laborId (string): Unique identifier for the labor entry.
  • worker (string): Name of the worker performing the labor.
  • laborCode (string): Code related to the labor task.
  • laborRate (number): Rate charged for the labor (e.g., hourly rate).
  • hoursWorked (object, required): The time spent working.
  • totalCost (number): Total cost for the labor entry.
  • note (string, optional): Additional notes related to the labor entry.
• remarks (array of objects, required): Array of remark objects related to the work order. Each remark contains:
  • remarkId (string): Unique identifier for the remark.
  • comment (string, required): Comment or note about the remark.
  • attachments (array of objects, optional): Attachments related to the remark.
• attachments (array of objects, required): Array of attachments related to the work order. Each attachment contains:
  • attachmentType (string, required): Type of attachment (e.g., "Invoice").
  • attachmentDescription (string, optional): Description of the attachment.
  • fileUrl (string, required): URL where the attachment can be accessed.
• additionalCost (array of objects, optional): Array of additional cost entries. Each entry contains:
  • costDescription (string, required): Description of the additional cost.
  • cost (number, required): The amount of the additional cost.
• createdBy (string, required): The user who created the work order.
• approval (object, required): Approval details for the work order. Contains:
  • approved (string, required): Whether the work order has been approved.
    Example: "Yes"

Responses

Various responses depending on the result...

Retrieve a Work Order by ID

API for retrieving the full details of a specific work order by its unique ID.

Overview

This endpoint allows you to retrieve the details of a specific work order by providing the work order ID.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order.
  Example: "1727310792675"

Responses

Various responses depending on the result...

Retrieve All Work Orders

API for retrieving a list of all work orders with basic details.

Overview

This endpoint allows you to retrieve the list of all work orders, including basic details such as title, status, priority, type, asset information, and created date.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/workorders

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• No parameters required for this endpoint.

Responses

Various responses depending on the result...

Delete a Work Order

API for deleting a specific work order by its unique ID.

Overview

This endpoint allows you to delete a work order by providing its unique ID.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order to delete.
  Example: "1727310792675"

Responses

Various responses depending on the result...

Bulk Delete Work Orders

API for deleting multiple work orders by providing an array of work order IDs.

Overview

This endpoint allows you to delete multiple work orders by providing an array of work order IDs.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/workorders/bulk-delete

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Request Payload

• workOrderIds (array, required): An array of work order IDs to be deleted.
  Example: ["WO1034", "WO1035", "WO1036"]

Responses

Various responses depending on the result...

Update Tasks for a Work Order

API for updating the tasks associated with a specific work order.

Overview

This endpoint allows you to update the tasks for a work order by providing the work order ID and a payload of tasks.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}/tasks

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order to update.
  Example: "1727310792675"

Request Payload

• tasks (array, required): An array of task objects containing the updated task details.
  • taskId (string): The unique ID of the task.
  • taskName (string): The name of the task.
  • taskStatus (string): The status of the task (e.g., "In Progress").
  • taskType (string): The type of the task (e.g., "Repair").
  • assignedTo (object): Details of the person assigned to the task.
    • assignedId (string): The ID of the person assigned to the task.
    • assignedName (string): The name of the person assigned to the task.
  • taskNote (string): Additional notes for the task.
  • dates (object): Details about the task's dates.
    • addedDate (string): The date the task was added (format: "YYYY-MM-DD HH:MM AM/PM").
    • reportedDate (string): The date the task was reported (format: "YYYY-MM-DD HH:MM AM/PM").
  • reportedBy (string): The person who reported the task.

Responses

Various responses depending on the result...

Update Parts for a Work Order

API for updating the parts associated with a specific work order.

Overview

This endpoint allows you to update the parts related to a specific work order by providing the necessary part details.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}/parts

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order to update.
  Example: "1727310792675"

Request Payload

• parts (array, required): Array of part objects containing details of the parts to update.
  • partId (string, required): Unique ID of the part.
  • itemNumber (string, required): The part's item number.
  • itemName (string, required): The name of the part.
  • quantity (integer, required): Quantity of the part to update.
  • unit (string, required): Unit of the part.
  • itemCost (number, required): Cost per unit of the part.

Responses

Various responses depending on the result...

Update Labor for a Work Order

API for updating labor details associated with a specific work order.

Overview

This endpoint allows you to update the labor details associated with a specific work order by providing the work order ID.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}/labor

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order to update.
  Example: "1727310792675"

Request Payload

• labor (array, required): Array of labor objects containing details of the labor to update.
  • laborId (string, required): Unique ID of the labor entry.
  • worker (string, required): Name of the worker.
  • laborCode (string, required): The code for the labor category.
  • laborRate (number, required): The hourly rate of the labor.
  • hoursWorked (object, required): The time worked by the labor.
    • hours (integer, required): Hours worked.
    • minutes (integer, required): Minutes worked.
  • totalCost (number, required): The total cost for the labor.

Responses

Various responses depending on the result...

Update Remarks for a Work Order

API for updating the remarks associated with a specific work order.

Overview

This endpoint allows you to update the remarks for a work order by providing its unique ID.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}/remarks

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order.
  Example: "1727310792675"

Request Payload

• remarks (array, required): Array of remark objects containing details of the remarks to update.
  • remarkId (string, required): Unique ID of the remark.
  • comment (string, required): The comment associated with the remark.
  • attachments (array, optional): List of attachment objects associated with the remark.
    • fileName (string, required): The name of the attachment file.
    • fileUrl (string, required): The URL of the attachment file.

Responses

Various responses depending on the result...

Update Attachments for a Work Order

API for updating the attachments associated with a specific work order.

Overview

This endpoint allows you to update the attachments for a specific work order by providing its unique ID and the attachment details.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/workorders/{id}/attachments

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the work order to update.
  Example: "1727310792675"

Request Payload

• attachments (array, required): Array of attachment objects containing the attachment details to be updated.
  • attachmentType (string, required): Type of the attachment (e.g., "Invoice").
  • attachmentDescription (string, required): Description of the attachment (e.g., "Invoice for maintenance").
  • fileUrl (string, required): URL of the attachment file (e.g., "https://oxmaint.com/files/invoice.pdf").

Responses

Various responses depending on the result...

Request Maintenance

This API is coming soon...

POST: Create a Service Schedule

This API creates a new service schedule with the specified details.

Overview

This endpoint allows you to create a new service schedule in the Oxmaint system.

Endpoint

POST https://api.oxmaint.com/{cilent_id}/v1/service-schedule

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• scheduleId (string, required): Unique schedule ID.
  Example: "SCH1073"
• masterEmail (string, required): Email of the master user creating the schedule.
  Example: "oxmainti@gmail.com"
• status (string, required): Status of the schedule.
  Example: "1"
• createdBy (string, required): Name of the user creating the schedule.
  Example: "DEMO FRAPORT"
• vehicleName (string, required): Name of the vehicle.
  Example: "Aircraft Pushback Tractor"
• scheduleTitle (string, required): Title of the schedule.
  Example: "ScheduleDemoTesting"
• intervalReading (string, required): Interval value based on vehicle meter readings.
  Example: "300"
• createdDate (string, required): Date when the schedule is created.
  Example: "21-Nov-2024 04:21 PM"

Responses

Various responses depending on the result...

GET: Retrieve a Service Schedule by ID

This API retrieves the details of a specific service schedule by providing the service schedule ID.

Overview

This endpoint allows you to retrieve the details of a specific service schedule in the Oxmaint system.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/service-schedule/{id}

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the service schedule.
  Example: "6cfb5004-0708-4d61-94b7-f081acdf0ab8"

Responses

Various responses depending on the result...

PUT: Update a Service Schedule

This API updates the details of an existing service schedule.

Overview

This endpoint allows you to update an existing service schedule in the Oxmaint system by providing the schedule ID and updated details.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/service-schedule/{id}

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the service schedule to be updated.
  Example: "6cfb5004-0708-4d61-94b7-f081acdf0ab8"

Request Body

• scheduleTitle (string, optional): Updated title of the schedule.
  Example: "Updated Schedule Title"
• intervalReading (string, optional): Updated interval value based on vehicle meter readings.
  Example: "400"
• status (string, optional): Updated status of the schedule.
  Example: "Active"
• note (string, optional): Additional notes for the service schedule.
  Example: "Service schedule updated with new interval."

Responses

Various responses depending on the result...

DELETE: Delete a Service Schedule

This API deletes an existing service schedule by providing the service schedule ID.

Overview

This endpoint allows you to delete an existing service schedule in the Oxmaint system.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/service-schedule/{id}

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the service schedule to be deleted.
  Example: "6cfb5004-0708-4d61-94b7-f081acdf0ab8"

Responses

Various responses depending on the result...

POST: Create a Part

This API creates a new part in the inventory with the specified details.

Overview

This endpoint allows you to create a new part in the inventory within the Oxmaint system.

Endpoint

POST https://api.oxmaint.com/{cilent_id}/v1/parts-inventory

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• itemName (string, required): Name of the part.
  Example: "Cycle"
• itemNumber (string, required): Unique SKU or identifier for the part.
  Example: "SKU1158021"
• quantity (string, required): Quantity of the part available in inventory.
  Example: "902"
• unit (string, required): Unit of the part.
  Example: "Piece"
• amount (string, required): Monetary value associated with the part.
  Example: "8000"
• manufacturer (string, required): Manufacturer of the part.
  Example: "Temple"
• partNumber (string, required): Part number.
  Example: "64251"
• category (string, required): Category of the part.
  Example: "Maintenance Equipment"
• status (string, required): Status of the part.
  Example: "1"

Responses

Various responses depending on the result...

GET: Retrieve a Part by ID

This API retrieves the details of a specific part in the inventory by providing the part ID.

Overview

This endpoint allows you to retrieve the details of a specific part in the inventory within the Oxmaint system.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/parts-inventory/{id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the part in the inventory.
  Example: "aa435607-eec2-40e2-baa1-9f1a115d144a"

Responses

Various responses depending on the result...

GET: Retrieve All Parts

This API retrieves a list of all parts in the inventory, with optional query parameters for filtering, searching, and pagination.

Overview

This endpoint allows you to retrieve all parts in the inventory within the Oxmaint system.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/parts-inventory

Headers

• Authorization: Bearer <API_TOKEN>

Query Parameters

• search (string, optional): Search by part name, SKU, or category.
  Example: "Cycle"
• page (int, optional): Page number for pagination. Default is 1.
  Example: "1"
• limit (int, optional): Number of parts per page. Default is 10.
  Example: "10"
• category (string, optional): Filter parts by category.
  Example: "Maintenance Equipment"
• status (string, optional): Filter by part status.
  Example: "Active"

Responses

Various responses depending on the result...

PUT: Update a Part

This API updates the details of an existing part in the inventory by providing the part ID.

Overview

This endpoint allows you to update the details of a specific part in the inventory within the Oxmaint system.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/parts-inventory/{id}

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the part in the inventory.
  Example: "aa435607-eec2-40e2-baa1-9f1a115d144a"

Request Body

• itemName (string, required): Updated name of the part.
  Example: "Updated Cycle"
• quantity (string, required): Updated quantity of the part.
  Example: "800"
• amount (string, required): Updated monetary value associated with the part.
  Example: "7500"
• status (string, required): Updated status of the part.
  Example: "Active"

Responses

Various responses depending on the result...

DELETE: Delete a Part

This API deletes a specific part from the inventory by providing the part ID.

Overview

This endpoint allows you to delete a specific part from the inventory within the Oxmaint system.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/parts-inventory/{id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the part in the inventory.
  Example: "aa435607-eec2-40e2-baa1-9f1a115d144a"

Responses

Various responses depending on the result...

DELETE: Bulk Delete Parts

This API deletes multiple parts from the inventory by providing their unique IDs.

Overview

This endpoint allows you to delete multiple parts from the inventory within the Oxmaint system.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/parts-inventory/bulk-delete

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Request Body

• partIds (array, required): Array of part IDs to be deleted.
  Example: ["aa435607-eec2-40e2-baa1-9f1a115d144a", "bb435607-eec2-40e2-baa1-9f1a115d144b"]

Responses

Various responses depending on the result...

POST: Create a New Purchase Order

This API creates a new purchase order with all necessary details, including vendor information, shipping details, priority, and more.

Overview

This endpoint allows you to create a new purchase order in the Oxmaint system.

Endpoint

POST https://api.oxmaint.com/{cilent_id}/v1/purchase-orders

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• poTitle (string, required): Title of the purchase order.
  Example: "POTesting"
• description (string, optional): Description of the purchase order.
  Example: "Purchase order description"
• dueDate (string, optional): Due date for the purchase order.
  Format: YYYY-MM-DD
• vendorName (string, optional): Name of the vendor.
  Example: "Vendor ABC"
• vendorAddress (string, optional): Address of the vendor.
  Example: "123 Vendor St., City, Country"
• requesterName (string, optional): Name of the requester who initiated the purchase order.
  Example: "John Doe"
• priority (string, required): Priority level of the purchase order.
  Example: "0" (Low), "1" (Medium), "2" (High)
• poType (string, required): Type of the purchase order.
  Example: "Subcontracting", "Material"
• linkWorkOrder (string, optional): Work order associated with the purchase order.
  Example: "WO1234"
• linkVehicle (string, optional): Vehicle associated with the purchase order.
  Example: "Vehicle123"
• shippingAddress (string, optional): Shipping address for the purchase order.
  Example: "456 Shipping Rd., City, Country"
• shippingCity (string, optional): City for the shipping address.
  Example: "CityName"
• termsCondition (string, optional): Terms and conditions associated with the purchase order.
  Example: "Payment due within 30 days."
• subTotal (string, required): Subtotal amount for the purchase order.
  Example: "1000"
• salesTax (string, required): Sales tax applied to the purchase order.
  Example: "100"
• shippingCharge (string, required): Shipping charges for the purchase order.
  Example: "50"
• totalCost (string, required): Total cost of the purchase order, including taxes and shipping charges.
  Example: "1150"
• itemCount (string, required): Number of items in the purchase order.
  Example: "1"
• createdBy (string, required): Name of the user who created the purchase order.
  Example: "DEMO FRAPORT"
• locationId (string, required): Location associated with the purchase order.
  Example: "Default-001"
• status (string, required): Status of the purchase order.
  Example: "1" (Active), "0" (Inactive)

Responses

Various responses depending on the result...

GET: Retrieve a Purchase Order by ID

This API retrieves the full details of a specific purchase order by its unique ID.

Overview

This endpoint allows you to fetch the details of a purchase order by providing its unique identifier.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/purchase-orders/{id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): The unique identifier of the purchase order.
  Example: "1732235244994"

Responses

Various responses depending on the result...

GET: Retrieve All Purchase Orders

This API fetches a list of all purchase orders in the system, with optional filters for search, pagination, and status.

Overview

This endpoint allows you to retrieve all purchase orders with optional query parameters for filtering and pagination.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/purchase-orders

Headers

• Authorization: Bearer <API_TOKEN>

Query Parameters

• search (string, optional): Search by PO title, number, or vendor.
  Example: "POTesting"
• status (string, optional): Filter purchase orders by status.
  Example: "Active", "Closed"
• page (integer, optional): The page number for pagination.
  Example: "1"
• limit (integer, optional): The number of results per page.
  Example: "10"

Responses

Various responses depending on the result...

PUT: Update a Purchase Order

This API updates an existing purchase order with new details such as title, description, vendor information, priority, and more.

Overview

This endpoint allows you to update an existing purchase order in the Oxmaint system by providing its unique ID and updated details.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/purchase-orders/{id}

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): The unique identifier of the purchase order to update.
  Example: "1732235244994"

Request Body

• poTitle (string, required): The updated title of the purchase order.
  Example: "Updated Title"
• description (string, optional): The updated description of the purchase order.
  Example: "Updated Description"
• vendorName (string, optional): The updated name of the vendor.
  Example: "Updated Vendor"
• priority (string, optional): The updated priority level of the purchase order.
  Example: "1"
• totalCost (string, optional): The updated total cost of the purchase order.
  Example: "5000"
• status (string, optional): The updated status of the purchase order.
  Example: "Approved"

Responses

Various responses depending on the result...

DELETE: Delete a Purchase Order

This API deletes a specific purchase order by its unique ID.

Overview

This endpoint allows you to delete an existing purchase order from the Oxmaint system by providing its unique identifier.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/purchase-orders/{id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): The unique identifier of the purchase order to delete.
  Example: "1732235244994"

Responses

Various responses depending on the result...

DELETE: Bulk Delete Purchase Orders

This API allows you to delete multiple purchase orders at once by providing their unique IDs.

Overview

This endpoint enables bulk deletion of purchase orders by specifying their unique identifiers in the request body.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/purchase-orders/bulk-delete

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Request Body

• poIds (array of strings, required): List of unique identifiers for the purchase orders to delete.
  Example: ["1732235244994", "1234567890123"]

Responses

Various responses depending on the result...

GET: Retrieve Purchase Orders by Status

This API retrieves all purchase orders with a specific status, such as "Active" or "Closed."

Overview

This endpoint allows you to filter purchase orders based on their status and retrieve the matching results.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/purchase-orders/status/{status}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• status (string, required): The status of the purchase orders to filter by.
  Example: "Active", "Closed"

Responses

Various responses depending on the result...

POST: Create a New Demand Part

This API creates a new demand part entry with all the required details.

Overview

This endpoint allows you to create a new demand part in the system.

Endpoint

POST https://api.oxmaint.com/{client_id}/v1/demand-parts

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• requestTitle (string, required): Title of the demand part request.
  Example: "New Battery Request"
• description (string, optional): Description of the demand part request.
  Example: "Urgent requirement for backup batteries"
• dueDate (string, optional): Due date for the demand part request.
  Example: "2024-12-15"
• requesterName (string, required): Name of the requester.
  Example: "John Doe"
• priority (string, required): Priority level of the request.
  Example: "1" (1 for High, 0 for Low)
• linkWorkorder (string, optional): Associated work order ID.
  Example: "WO12345"
• linkVehicle (string, optional): Associated vehicle ID.
  Example: "V1023"
• itemNumber (string, required): Unique SKU or item number for the part.
  Example: "SKU467312"
• itemName (string, required): Name of the part.
  Example: "Battery"
• itemQty (string, required): Quantity of the part needed.
  Example: "82"
• itemUnit (string, required): Unit of the item.
  Example: "Piece"
• partNumber (string, required): Part number of the item.
  Example: "163-9380"
• make (string, optional): Manufacturer of the part.
  Example: "ABC Manufacturing"

Responses

Various responses depending on the result...

GET: Retrieve Demand Part by ID

This API retrieves details of a specific demand part using its unique ID.

Overview

This endpoint allows you to fetch the details of a specific demand part by providing its unique identifier.

Endpoint

GET https://api.oxmaint.com/{client_id}/v1/demand-parts/{id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): The unique identifier of the demand part.
  Example: "63dcaa67-e23b-48e2-8591-ef3cbb8ed79c"

Responses

Various responses depending on the result...

GET: Retrieve All Demand Parts

This API retrieves a list of all demand parts in the system.

Overview

This endpoint allows you to fetch all demand parts with optional filters for status and priority.

Endpoint

GET https://api.oxmaint.com/{client_id}/v1/demand-parts

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• status (string, optional): Filter demand parts by status (e.g., "active").
  Example: "active"
• priority (string, optional): Filter demand parts by priority (e.g., "high").
  Example: "high"

Responses

Various responses depending on the result...

PUT: Update a Demand Part

This API updates the details of an existing demand part.

Overview

This endpoint allows you to update the details of a specific demand part by providing its unique ID.

Endpoint

PUT https://api.oxmaint.com/{client_id}/v1/demand-parts/{id}

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): The unique identifier of the demand part.
  Example: "63dcaa67-e23b-48e2-8591-ef3cbb8ed79c"

Request Body

• requestTitle (string, required): Title of the demand part request.
  Example: "Updated Battery Request"
• description (string, optional): Description of the demand part request.
  Example: "Battery request updated with new quantity"
• dueDate (string, optional): Due date for the demand part request.
  Example: "2024-12-20"
• priority (string, optional): Priority of the request.
  Example: "2" (High)
• itemQty (string, required): Quantity of the requested item.
  Example: "90"
• make (string, optional): Manufacturer or brand of the requested item.
  Example: "XYZ Manufacturing"

Responses

Various responses depending on the result...

DELETE: Delete a Demand Part

This API deletes a specific demand part by its unique ID.

Overview

This endpoint allows you to delete a specific demand part from the system.

Endpoint

DELETE https://api.oxmaint.com/{client_id}/v1/demand-parts/{id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): The unique identifier of the demand part to delete.
  Example: "63dcaa67-e23b-48e2-8591-ef3cbb8ed79c"

Responses

Various responses depending on the result...

DELETE: Bulk Delete Demand Parts

This API deletes multiple demand parts in a single request.

Overview

This endpoint allows you to remove multiple demand parts by providing their unique IDs in the request payload.

Endpoint

DELETE https://api.oxmaint.com/{client_id}/v1/demand-parts/bulk-delete

Headers

• Authorization: Bearer <API_TOKEN>
• Content-Type: application/json

Parameters

• demandIds (array of strings, required): Array of IDs of the demand parts to be deleted.
  Example: ["63dcaa67-e23b-48e2-8591-ef3cbb8ed79c", "73aeac56-e34f-42b9-a89c-f3cbb8db45ac"]

Responses

Various responses depending on the result...

GET: Search Demand Parts by Status

This API retrieves a list of demand parts filtered by their status (e.g., "active").

Overview

This endpoint allows you to search for demand parts based on their status, such as "active" or "inactive".

Endpoint

GET https://api.oxmaint.com/{client_id}/v1/demand-parts/status/{status}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• status (string, required): The status of the demand parts to retrieve.
  Example: "active"

Responses

Various responses depending on the result...

POST: Create a New Vendor

This API creates a new vendor with all necessary details such as contact information, address, and vendor type.

Overview

This endpoint allows you to add a new vendor to the Oxmaint system.

Endpoint

POST https://api.oxmaint.com/{client_id}/v1/vendors

Headers

• Content-Type: application/json
• Authorization: Bearer <API_TOKEN>

Parameters

• id (string, required): Unique identifier for the vendor.
  Example: "d6e1205f-ac37-47be-aac5-0516a207ed15"
• master_email (string, required): The email associated with the master account.
  Example: "oxmainti@gmail.com"
• vendor_id (string, required): Unique ID for the vendor.
  Example: "008"
• vendor_name (string, required): Name of the vendor.
  Example: "Star Elevator"
• contact_person (string, optional): Name of the contact person.
  Example: "John Doe"
• work_email (string, optional): Email of the contact person.
  Example: "john.doe@example.com"
• mobile (string, optional): Mobile number of the vendor.
  Example: "+123456789"
• address (string, optional): Address of the vendor.
  Example: "123 Main St"
• city (string, optional): City of the vendor.
  Example: "New York"
• added_date (string, required): Date the vendor was added.
  Example: "19-Jul-2024 04:07 PM"
• added_by (string, required): The user who added the vendor.
  Example: "DEMO FRAPORT"
• location_id (string, required): Location ID for the vendor.
  Example: "Default-001"
• tax_id (string, optional): Tax identification number for the vendor.
  Example: "TAX12345"
• vendor_type (string, required): Type of the vendor.
  Example: "2"
• description (string, optional): Description of the vendor.
  Example: "Elevator maintenance services"
• hourly_rate (string, optional): Hourly rate for the vendor's services.
  Example: "150"

Responses

Various responses depending on the result:

GET: Retrieve Vendor by ID

This API retrieves details of a specific vendor by its unique ID.

Overview

This endpoint allows you to fetch detailed information about a vendor available in the system using its unique identifier.

Endpoint

GET https://api.oxmaint.com/{client_id}/v1/vendors/{vendor_id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• vendor_id (string, required): Unique identifier for the vendor.
  Example: "d6e1205f-ac37-47be-aac5-0516a207ed15"

Responses

Various responses depending on the result:

GET: Retrieve All Vendors

This API retrieves a list of all vendors available in the system.

Overview

This endpoint allows you to fetch a comprehensive list of all vendors present in the system.

Endpoint

GET https://api.oxmaint.com/{client_id}/v1/vendors

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• page (integer, optional): The page number for pagination.
  Example: 1
• limit (integer, optional): Number of vendors per page.
  Example: 20
• search (string, optional): Search query for filtering vendors.
  Example: "Star Elevator"

Responses

Various responses depending on the result:

DELETE: Delete Vendor

This API deletes a specific vendor by its unique ID.

Overview

This endpoint allows you to delete a vendor from the system using its unique identifier.

Endpoint

DELETE https://api.oxmaint.com/{client_id}/v1/vendors/{vendor_id}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• vendor_id (string, required): The unique identifier of the vendor to delete.
  Example: "d6e1205f-ac37-47be-aac5-0516a207ed15"

Responses

Various responses depending on the result:

DELETE: Bulk Delete Vendors

This API deletes multiple vendors in one request using their unique IDs.

Overview

This endpoint allows you to delete multiple vendors from the system by providing their unique identifiers in the request body.

Endpoint

DELETE https://api.oxmaint.com/{client_id}/v1/vendors/bulk

Headers

• Authorization: Bearer <API_TOKEN>
• Content-Type: application/json

Request Body

• vendor_ids (array of strings, required): Array of unique IDs of the vendors to delete.
  Example: ["001", "002", "003"]

Responses

Various responses depending on the result:

PUT: Update Vendor

This API updates the details of an existing vendor in the system.

Overview

This endpoint allows you to update an existing vendor's information such as name, contact details, address, and other attributes.

Endpoint

PUT https://api.oxmaint.com/{client_id}/v1/vendors/{vendor_id}

Headers

• Authorization: Bearer <API_TOKEN>
• Content-Type: application/json

Parameters

• vendor_id (string, required): Unique identifier of the vendor to update.
  Example: "d6e1205f-ac37-47be-aac5-0516a207ed15"

Request Body

• vendor_name (string, optional): The name of the vendor.
  Example: "Star Elevator Services"
• contact_person (string, optional): Name of the primary contact person.
  Example: "Jane Doe"
• work_email (string, optional): Work email of the vendor.
  Example: "jane.doe@example.com"
• mobile (string, optional): Mobile number of the vendor.
  Example: "+987654321"
• address (string, optional): Address of the vendor.
  Example: "456 Elm St"
• city (string, optional): City of the vendor.
  Example: "Los Angeles"
• tax_id (string, optional): Tax identification number of the vendor.
  Example: "TAX67890"
• vendor_type (string, optional): Type of the vendor.
  Example: "1"
• description (string, optional): Description or notes about the vendor.
  Example: "Updated vendor information"
• hourly_rate (string, optional): Hourly rate charged by the vendor.
  Example: "200"

Responses

Various responses depending on the result:

GET: Get Vendors by Type

This API retrieves a list of vendors filtered by their type.

Overview

This endpoint allows you to fetch vendors based on their specified type.

Endpoint

GET https://api.oxmaint.com/{client_id}/v1/vendors/type/{vendor_type}

Headers

• Authorization: Bearer <API_TOKEN>

Parameters

• vendor_type (string, required): The type of vendors to retrieve.
  Example: "2"

Responses

Various responses depending on the result:

Retrieve Inspection Report by ID

API for retrieving the full details of a specific Inspection Report by its unique ID.

Overview

This endpoint allows you to retrieve the details of a specific inspection report by providing the inspection report ID.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/inspection/reports/{id}

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the inspection report.
  Example: "1730765544738"

Responses

Various responses depending on the result...

Create New Inspection Report

API for creating the full details of a specific Inspection Report.

Overview

This endpoint allows you to create a new inspection report.

Endpoint

GET https://api.oxmaint.com/{cilent_id}/v1/inspection/reports

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• reportNumber (string, required): Report number associated with the inspection (e.g., "OXmaint1007").
• location (string, required): Location where the inspection took place (e.g., "Germany").
• inspectorName (string, required): Name of the inspector conducting the inspection (e.g., "DEMO FRAPORT").
• inspectionDate (string, required): Date and time of the inspection in ISO 8601 format (e.g., "2024-11-04T16:12:00Z").
• assetName (string, required): Name of the asset inspected (e.g., "Tractor-1").
• assetSerialNumber (string, required): Serial number of the asset inspected (e.g., "2923").
• assetVIN (string, required): Vehicle Identification Number (VIN) of the asset (e.g., "100").
• assetModel (string, required): Model of the asset inspected (e.g., "John Deere 8R 230").
• maintenanceRequired (integer, required): Indicator if maintenance is required (0 = No, 1 = Yes).
• maintenancePriority (string, required): Priority level of required maintenance (e.g., "Low").
• overallCondition (string, required): Overall condition of the asset post-inspection (e.g., "Excellent Condition").
• safeToUse (boolean, required): Indicator if the asset is safe to use (true/false).
• meterReading (string, required): Current meter reading of the asset (e.g., "0 Miles").
• groupName (string, required): Name of the group associated with the inspection (e.g., "DAILY AVIATION SECURITY CONTROL").

Responses

Various responses depending on the result...

Update Inspection Report

API for updating the details of a specific inspection report by its unique ID.

Overview

This endpoint allows you to update details of an existing inspection report by providing the inspection report ID.

Endpoint

PUT https://api.oxmaint.com/{cilent_id}/v1/inspection/reports/{id}

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the inspection report to update.
  Example: "1730765544738"

Request Body

• location (string, required): Location where the inspection took place (e.g., "Germany").
• inspectorName (string, required): Name of the inspector conducting the inspection (e.g., "DEMO FRAPORT").
• inspectionDate (string, required): Date and time of the inspection in ISO 8601 format (e.g., "2024-11-04T16:12:00Z").
• maintenanceRequired (integer, required): Indicator if maintenance is required (0 = No, 1 = Yes).
• maintenancePriority (string, required): Priority level of required maintenance (e.g., "Low").
• overallCondition (string, required): Overall condition of the asset post-inspection (e.g., "Excellent Condition").
• safeToUse (boolean, required): Indicator if the asset is safe to use (true/false).

Responses

Various responses depending on the result...

Delete Inspection Report

API for deleting an existing inspection report by its unique ID.

Overview

This endpoint allows you to delete an existing inspection report by providing the inspection report ID.

Endpoint

DELETE https://api.oxmaint.com/{cilent_id}/v1/inspection/reports/{id}

Headers

• Authorization (string, required): Bearer token to authenticate the request.
  Example: "Bearer {token}"

Parameters

• id (string, required): The unique identifier of the inspection report to delete.
  Example: "1730765544738"

Responses

Various responses depending on the result...