Bandag API

API Endpoint
https://laravel.bandag.zerobox.co.za

Welcome to the Bandag API, here you will find all the information related to the endpoints available.

Authentication

The API uses oAuth2 for authentication, this means that all API calls should contain and authorization that looks like this

Authorization: Bearer API_KEY_HERE

Please see the Authentication documentation to know how to get an access token.

Headers

Make sure you have the following content type headers are set on every request:

Accept: application/vnd.api.v1+json
Content-Type: application/json

Errors

The API uses conventional HTTP response codes to indicate the success or failure of an API request. The table below contains a summary of the typical response codes:

Code Description
200 Everything is ok.
400 Valid data was given but the request has failed.
401 No valid API Key was given.
404 The request resource could not be found.
405 The method is not implemented
422 The payload has missing required parameters or invalid data was given.
429 Too many attempts.
500 Request failed due to an internal error.
503 API is offline for maintenance.

Resource Group

Store

POST https://laravel.bandag.zerobox.co.za/api/user-access-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "name": "Test"
    },
    {
      "ref_key": "tex",
      "name": "Test 2"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "name": "Dummy Text 1",
      "guard_name": "web",
      "created_at": "2022-02-17T17:27:08.472932Z",
      "updated_at": "2022-02-17T17:27:08.472948Z"
    },
    {
      "name": "Dummy Text 2",
      "guard_name": "web",
      "created_at": "2022-02-17T17:27:08.473197Z",
      "updated_at": "2022-02-17T17:27:08.473209Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-access-types/multiple

This endpoint will allow you to create records This end point does not allow duplicated names

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. name (string, required) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/user-access-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "name": "Dummy Text 2",
    "guard_name": "web",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/user-access-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/user-access-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
{
  "records": [
    {
      "ref_key": "abc",
      "name": "Test 33"
    },
    {
      "ref_key": "tex",
      "name": "Test 233"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/user-access-types/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. name (string, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/user-access-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-access-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. name (string, required) required for new record

  3. guard_name (string, required) required and must always be “web”

Export

POST https://laravel.bandag.zerobox.co.za/api/user-access-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-user-access-type.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-access-types/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. emailaddress Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/user-access-typess/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/user-access-typess/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

User Login

Resources related to maintenance in the API.

User Login is a simple maintenance API

Login

POST https://laravel.bandag.zerobox.co.za/api/user/login
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
{
  "username": "John",
   "password": "************",
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwian....."
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Login
POST/api/user/login

This endpoint will allow an existing user to login and receive access token

Values

  1. username (string, required) This is the email address

  2. password (string, required) This is the user password

User Password Reset

Resources related to maintenance in the API.

User Password Reset is a simple maintenance API

Password Reset

POST https://laravel.bandag.zerobox.co.za/api/password/reset
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
{
  "username": "John",
   "password": "************",
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "message": "The reset password  email is sent successfully"
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Password Reset
POST/api/password/reset

This endpoint will allow an existing user to reset password and get new credentials via email

Values

  1. username (string, required) This is the username that will retrieve related email for username

Users

Resources related to maintenance in the API.

Users is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/users
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "John",
      "surname": "Doe",
      "username": "John",
      "cell": "2782000000",
      "email": "example@domain.co.za",
      "password": "*********",
      "eta_service_providers_id": "2",
      "company": "Dummy Text",
      "ln_customer_code": "Dummy Text",
      "current_customer_ln_customer_code": "Dummy Text",
      "mobile_user": 1,
      "mobile_user_can_enter_manual_readings": 1,
      "super_report_user": 1,
      "is_service_engineer": 1,
      "mfd_locker": 0,
      "active": 1,
      "mfd_notification": 0,
      "created_at": "1970-01-01 00:01:00",
      "updated_at": "1970-01-01 00:01:00",
      "deleted_at": ""
    },
    {
      "id": 2,
      "name": "John",
      "surname": "Doe",
      "username": "Johnny",
      "cell": "2782000000",
      "email": "example@domain.co.za",
      "password": "*********",
      "eta_service_providers_id": "2",
      "company": "Dummy Text",
      "ln_customer_code": "",
      "current_customer_ln_customer_code": "Dummy Text",
      "mobile_user": 1,
      "mobile_user_can_enter_manual_readings": 1,
      "super_report_user": 1,
      "is_service_engineer": 0,
      "mfd_locker": 0,
      "active": 1,
      "mfd_notification": 0,
      "created_at": "1970-01-01 00:01:00",
      "updated_at": "1970-01-01 00:01:00",
      "deleted_at": ""
    }
  ],
  "meta": {
    "pagination": {
      "total": 1558,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 156,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/users?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/users

This endpoint will allow you to get the Users in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“name”: “asc”},
    • {“surname”: “asc”},
    • {“username”: “asc”},
    • {“cell”: “asc”},
    • {“email”: “asc”},
    • {“eta_service_providers_id”: “asc”},
    • {“company”: “asc”},
    • {“ln_customer_code”: “asc”},
    • {“current_customer_ln_customer_code”: “asc”},
    • {“mobile_user”: “asc”},
    • {“mobile_user_can_enter_manual_readings”: “asc”},
    • {“super_report_user”: “asc”},
    • {“is_service_engineer”: “asc”},
    • {“mfd_locker”: “asc”},
    • {“mfd_notification”: “asc”},

]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/users
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
name
surname
username
cell
email
password
eta_service_providers_id
company
ln_customer_code
current_customer_ln_customer_code
mobile_user
mobile_user_can_enter_manual_readings
super_report_user
is_service_engineer
mfd_locker
active
mfd_notification
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 10,
      "name": "John",
      "surname": "Doe",
      "username": "John",
      "cell": "27820000000",
      "email": "example@domain.co.za",
      "password": "*********",
      "eta_service_providers_id": "1",
      "company": "Dummy Text",
      "ln_customer_code": "",
      "current_customer_ln_customer_code": "Dummy Text",
      "mobile_user": 1,
      "mobile_user_can_enter_manual_readings": 1,
      "super_report_user": 1,
      "is_service_engineer": 1,
      "mfd_locker": 0,
      "active": 1,
      "mfd_notification": 1,
      "created_at": "1970-01-01 00:01:00",
      "updated_at": "1970-01-01 00:01:00",
      "deleted_at": ""
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/users

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. name (string, required) This is the column you want to store

  2. surname (string, required) This is the column you want to store

  3. username (string, required) This is the column you want to store (unique)

  4. cell (string, required) This is the column you want to store

  5. email (email, required) This is the column you want to store

  6. password (string, required) This is the column you want to store

  7. eta_service_providers_id (int, required) This is the column you want to store

  8. company (string, required) This is the column you want to store

  9. ln_customer_code (tinyInt, nullable) This is the column you want to store

  10. current_customer_ln_customer_code (tinyInt, nullable) This is the column you want to store

  11. mobile_user (tinyInt, nullable) This is the column you want to store

  12. mobile_user_can_enter_manual_readings (tinyInt, nullable) This is the column you want to store

  13. super_report_user (tinyInt, nullable) This is the column you want to store

  14. is_service_engineer (tinyInt, nullable) This is the column you want to store

  15. mfd_locker (tinyInt, nullable) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/users/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 10,
    "name": "John",
    "surname": "Doe",
    "username": "John",
    "cell": "27820000000",
    "email": "example@bdomain.co.za",
    "password": "*********",
    "eta_service_providers_id": "1",
    "company": "Dummy Text",
    "ln_customer_code": "",
    "current_customer_ln_customer_code": "Dummy Text",
    "mobile_user": 1,
    "mobile_user_can_enter_manual_readings": 1,
    "super_report_user": 1,
    "is_service_engineer": 1,
    "mfd_locker": 0,
    "active": 1,
    "mfd_notification": 1,
    "created_at": "1970-01-01 00:01:00",
    "updated_at": "1970-01-01 00:01:00",
    "deleted_at": ""
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/users/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/users/update/{id}
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
name
surname
username
cell
email
password
eta_service_providers_id
company
ln_customer_code
current_customer_ln_customer_code
mobile_user
mobile_user_can_enter_manual_readings
super_report_user
is_service_engineer
mfd_locker
active
mfd_notification
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/users/update/{id}

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. name (string, required) This is the column you want to store

  2. surname (string, required) This is the column you want to store

  3. username (string, required) This is the column you want to store (unique)

  4. cell (string, required) This is the column you want to store

  5. email (email, required) This is the column you want to store

  6. password (string, required) This is the column you want to store

  7. eta_service_providers_id (int, required) This is the column you want to store

  8. company (string, required) This is the column you want to store

  9. ln_customer_code (tinyInt, nullable) This is the column you want to store

  10. current_customer_ln_customer_code (tinyInt, nullable) This is the column you want to store

  11. mobile_user (tinyInt, nullable) This is the column you want to store

  12. mobile_user_can_enter_manual_readings (tinyInt, nullable) This is the column you want to store

  13. super_report_user (tinyInt, nullable) This is the column you want to store

  14. is_service_engineer (tinyInt, nullable) This is the column you want to store

  15. mfd_locker (tinyInt, nullable) This is the column you want to store

Export

POST https://laravel.bandag.zerobox.co.za/api/users/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "export_type": "1",
    "email": "example@domain.co.za",
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-User.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/users/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. emailaddress Only required for email options

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/users/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/users/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Alert

Resources related to maintenance in the API.

Alert is a simple maintenance API [Mbusi]

List All

GET https://laravel.bandag.zerobox.co.za/api/alerts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Testing Cccc",
      "emailaddress": "example@domain.co.za",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Testing DDD",
      "emailaddress": "example@domain.co.za",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/alerts?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/alerts

This endpoint will allow you to get the Alert in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“emailaddress”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/alerts/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        {"ref_key":"111", "description":"Description Aaaa", "emailaddress": "example@domain.co.za" },
        {"ref_key":"112", "description":"Description Bbbb", "emailaddress": "example@domain.co.za" },
    ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "description": "test",
      "emailaddress": "example@domain.com",
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "description": "test",
      "emailaddress": "example@domain.com",
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/alerts/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, reqired) This is the column you want to store

  3. emailaddress (email, reqired) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/alerts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "description Aaaaa",
    "emailaddress": "example@domain.co.za",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/alerts/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/alerts/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "description":"Description Aaaa", "emailaddress": "example@domain.co.za" },
    {"ref_key":"112", "description":"Description Bbbb", "emailaddress": "example@domain.co.za" },
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/alerts/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. emailaddress (email, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/alerts/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/alerts/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) required for new record

  3. emailaddress (email, required) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/alerts/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/alerts/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. emailaddress Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/alerts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/alerts/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Ancillary Product Groups

Resources related to maintenance in the API.

Ancillary Product Groups is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Testing Cccc",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Testing DDD",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/ancillary-product-groups

This endpoint will allow you to get the ancillary product groups in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/ancillary-product-groups

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "description Aaaaa",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/ancillary-product-groups/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/ancillary-product-groups

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/ancillary-product-groups/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/ancillary-product-groups/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/ancillary-product-groups/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/ancillary-product-groups/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/ancillary-product-groups/list

This endpoint will allow you to list a record

Ancillary Product Categories

Resources related to maintenance in the API.

Ancillary Product Categories is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 2,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "ancillary_product_group": {
        "id": 99,
        "description": "INNER TUBES",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 3,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "ancillary_product_group": {
        "id": 100,
        "description": "MISCELLANEOUS",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 4,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "ancillary_product_group": {
        "id": 102,
        "description": "SERVICE",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 5,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "ancillary_product_group": {
        "id": 103,
        "description": "NEW TYRES",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 1,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "ancillary_product_group": {
        "id": 98,
        "description": "BREAKDOWN",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 5,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/ancillary-product-categories

This endpoint will allow you to get the Ancillary Product Categories in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“ancillary_product_groups_id”: “asc”},
    • {“description”: “asc”},
    • {“ancillary_product_groups_id”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        {"ref_key":"111", "ancillary_product_groups_id":1, "description":"Dummy Text", "ancillary_product_groups_id": 1 },
        {"ref_key":"112", "ancillary_product_groups_id":1,"description":"Dummy Text", "ancillary_product_groups_id": 1 },
    ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "description": "Dummy text",
      "ancillary_product_groups_id": 1,
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "description": "Dummy text",
      "ancillary_product_groups_id": 1,
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/ancillary-product-categories/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, reqired) This is the column you want to store

  3. ancillary_product_groups_id (email, reqired) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Dummy Text",
    "deleted_at": "",
    "created_at": "2022-01-27 17:01:31",
    "updated_at": "2022-01-27 17:01:31",
    "ancillary_product_group": {
      "id": 98,
      "description": "BREAKDOWN",
      "created_at": "2022-01-27 17:01:13",
      "updated_at": "2022-01-27 17:01:13"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/ancillary-product-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "id": 1, "description":"Dummy Text", "ancillary_product_groups_id": 1 },
    {"ref_key":"112", "id": "2", "description":"Dummy Text", "ancillary_product_groups_id": 1 },

]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/ancillary-product-categories/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. ancillary_product_groups_id (email, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/ancillary-product-categories/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. ancillary_product_groups_id (numeric, required) if not supplied, an error will occur

  3. description (string, required) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/ancillary-product-categories/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/ancillary-product-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/ancillary-product-categories/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/ancillary-product-categories/list

This endpoint will allow you to list a record

Ancillary Products

Resources related to maintenance in the API.

Ancillary Products is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/ancillary-products
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "ancillary_product_categories_id": "15",
        "product_code": "#123",
        "product_description": "Description Aaaa",
        "poa": "1",
        "product_price_excl": "0",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "prev_page_url": null,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ancillary-products?page=2"
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/ancillary-products

This endpoint will allow you to get the Ancillary Products in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/ancillary-products
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","ancillary_product_categories_id":"15","description":"Description Aaaa"},
    {"ref_key":"222","ancillary_product_categories_id":"15","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/ancillary-products

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. ancillary_product_categories_id (numeric, required) This is the column you want to update

    • must exist in table ancillary_product_categories

  3. product_code (string, max:10, required) This is the column you want to update

  4. product_description (string, max:52, required) This is the column you want to update

  5. poa (numeric, required) This is the column you want to update

    • if poa is 1 then product_price_excl will be set to 0

  6. product_price_excl (numeric, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/ancillary-products/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "description Aaaaa",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/ancillary-products/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/ancillary-products
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"1","ancillary_product_categories_id":"15","product_code":"Code A","product_description":"Description Aaaa","poa": "1","product_price_excl": "150"},
    {"ref_key":"333","id":"2","ancillary_product_categories_id":"15","product_code":"Code B","product_description":"Description Bbbb","poa": "1","product_price_excl": "100"},
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/ancillary-products

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. ancillary_product_categories_id (numeric, required) This is the column you want to update

    • must exist in table ancillary_product_categories

  3. product_code (string, max:10, required) This is the column you want to update

  4. product_description (string, max:52, required) This is the column you want to update

  5. poa (numeric, required) This is the column you want to update

    • if poa is 1 then product_price_excl will be set to 0

  6. product_price_excl (numeric, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/ancillary-products/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/ancillary-products/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. ancillary_product_categories_id (numeric, required) This is the column you want to update

    • must exist in table ancillary_product_categories

  3. product_code (string, max:10, required) This is the column you want to update

  4. product_description (string, max:52, required) This is the column you want to update

  5. poa (numeric, required) This is the column you want to update

    • if poa is 1 then product_price_excl will be set to 0

  6. product_price_excl (numeric, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/ancillary-products/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Ancillary-Products.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/ancillary-products/export

This endpoint will allow you to Export the ancillary-products information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/ancillary-products/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/ancillary-products/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Applications

Resources related to maintenance in the API.

Applications is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/applications
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/applications?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/applications

This endpoint will allow you to get the Applications in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/applications/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/applications/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/applications/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/applications/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/applications/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/applications/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/applications/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/applications/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/applications/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/applications/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/applications/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/applications/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Area Of Opportunities

Resources related to maintenance in the API.

Area Of Opportunities is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/area-of-opportunities
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "code": "SA001",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "code": "SA001",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/area-of-opportunities?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/area-of-opportunities

This endpoint will allow you to get the Area Of Opportunities in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“code”: “SA001”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/area-of-opportunities/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        {"ref_key":"111", "description":"Dummy Text", "code": "SA001" },
        {"ref_key":"112", "description":"Dummy Text", "code": "SA001" },
    ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "code": "SA001",
      "description": "Dummy Text",
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "code": "SA001",
      "description": "Dummy Text",
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/area-of-opportunities/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. code (string, required) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/area-of-opportunities/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "code": "SA001",
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/area-of-opportunities/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/area-of-opportunities/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "description": "Dummy Text", "code": "SA001" },
    {"ref_key":"112", "description": "Dummy Text", "code": "SA001" },
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/area-of-opportunities/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. code (email, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/area-of-opportunities/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/area-of-opportunities/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) required for new record

  3. code (string, required) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/area-of-opportunities/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/AreaOfOpportunity-2022-01-27-13-38-43.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/area-of-opportunities/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. code Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/area-of-opportunities/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/area-of-opportunities/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Customer Groups

Resources related to maintenance in the API.

Customer Groups is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/customer-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Testing Cccc",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Testing DDD",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/customer-groups?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/customer-groups

This endpoint will allow you to get the customer groups in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/customer-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/customer-groups

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/customer-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "description Aaaaa",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/customer-groups/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/customer-groups
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/customer-groups

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/customer-groups/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/customer-groups/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/customer-groups/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/customer-groups/export

This endpoint will allow you to Export the customer-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/customer-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/customer-groups/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/customer-groups/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/customer-groups/list

This endpoint will allow you to list a record

Customer Sub Groups

Resources related to maintenance in the API.

Customer Sub Groups is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/customer-sub-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "customer_groups_id": "15",
        "description": "Description Aaaa",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "prev_page_url": null,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/customer-sub-groups?page=2"
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/customer-sub-groups

This endpoint will allow you to get the Customer Sub Groups in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/customer-sub-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","customer_groups_id": "147",description":"Description Aaaa"},
    {"ref_key":"222","customer_groups_id": "147",description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/customer-sub-groups

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. customer_groups_id (numeric, required) This is the column you want to update

    • must exist in table customer_groups

  3. description (string, max:10, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/customer-sub-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 36,
    "customer_groups_id": 145,
    "description": "CAPE REGION",
    "created_at": "2022-01-28 11:01:47",
    "updated_at": "2022-01-28 11:01:47",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/customer-sub-groups/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/customer-sub-groups
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"1","customer_groups_id":"15","description":"Code A","product_description":"Description Aaaa","poa": "1","product_price_excl": "150"},
    {"ref_key":"333","id":"2","customer_groups_id":"15","description":"Code B","product_description":"Description Bbbb","poa": "1","product_price_excl": "100"},
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/customer-sub-groups

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. customer_groups_id (numeric, required) This is the column you want to update

    • must exist in table customer_groups

  3. description (string, max:10, required) This is the column you want to update

  4. product_description (string, max:52, required) This is the column you want to update

  5. poa (numeric, required) This is the column you want to update

    • if poa is 1 then product_price_excl will be set to 0

  6. product_price_excl (numeric, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/customer-sub-groups/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/customer-sub-groups/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. customer_groups_id (numeric, required) This is the column you want to update

    • must exist in table customer_groups

  3. description (string, max:10, required) This is the column you want to update

  4. product_description (string, max:52, required) This is the column you want to update

  5. poa (numeric, required) This is the column you want to update

    • if poa is 1 then product_price_excl will be set to 0

  6. product_price_excl (numeric, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/customer-sub-groups/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Ancillary-Products.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/customer-sub-groups/export

This endpoint will allow you to Export the customer-sub-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/customer-sub-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/customer-sub-groups/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Config

Resources related to maintenance in the API.

Config is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/config
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "code": "SA001",
      "value": "9.99",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "code": "SA001",
      "value": "9.99",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/config?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/config

This endpoint will allow you to get the Config in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering between ASC and DESC

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
    • {“value”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/config/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        {"ref_key":"111", "description":"Dummy Text", "code": "SA001", "value": "9.99"},
        {"ref_key":"112", "description":"Dummy Text", "code": "SA001", , "value": "9.99"},
    ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "code": "SA001",
      "description": "Dummy Text",
      "value": "9.99",
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "code": "SA001",
      "description": "Dummy Text",
      "value": "9.99",
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/config/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. code (string, required) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/config/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "code": "SA001",
    "description": "Dummy Text",
    "value": "9.99",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/config/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/config/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "description": "Dummy Text", "code": "SA001", "value": "9.99" },
    {"ref_key":"112", "description": "Dummy Text", "code": "SA001", "value": "9.99" },
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/config/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. code (string, required) This is the column you want to update

  5. value (float, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/config/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/config/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) required for new record

  3. code (string, required) required for new record

  4. value (float, required) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/config/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/AreaOfOpportunity-2022-01-27-13-38-43.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/config/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. code Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/config/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/config/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Contract Preferences

Resources related to maintenance in the API.

Contract Preferences is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/contract-preferences
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/contract-preferences?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/contract-preferences

This endpoint will allow you to get the Contract Preferences in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering DESC or ASC Order

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/contract-preferences/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/contract-preferences/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/contract-preferences/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/contract-preferences/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/contract-preferences/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/contract-preferences/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/contract-preferences/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/contract-preferences/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/contract-preferences/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/contract-preferences/export

This endpoint will allow you to Export the Contract Preferences information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/contract-preferences/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/contract-preferences/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Customer Types

Resources related to maintenance in the API.

Customer Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/customer-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Prospect",
      "created_at": "2022-01-30 13:01:19",
      "updated_at": "2022-01-30 13:01:19",
      "deleted_at": null
    },
    {
      "id": 2,
      "description": "Existing",
      "created_at": "2022-01-30 13:01:19",
      "updated_at": "2022-01-30 13:01:19",
      "deleted_at": null
    },
    {
      "id": 3,
      "description": "Description Bulk Insert",
      "created_at": "2022-01-30 13:01:51",
      "updated_at": "2022-01-30 14:01:54",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/customer-types

This endpoint will allow you to get the customer types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/customer-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/customer-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/customer-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/customer-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/customer-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/customer-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/customer-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/customer-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/customer-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Customer-Types-2022-01-30-13-59-31.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/customer-types/export

This endpoint will allow you to Export the customer-types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/customer-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/customer-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Depot Types

Resources related to maintenance in the API.

Depot Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/depot-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Single",
      "created_at": "2022-01-30 14:01:46",
      "updated_at": "2022-01-30 14:01:46",
      "deleted_at": null
    },
    {
      "id": 2,
      "description": "Multiple",
      "created_at": "2022-01-30 14:01:46",
      "updated_at": "2022-01-30 14:01:46",
      "deleted_at": null
    },
    {
      "id": 3,
      "description": "B-Update",
      "created_at": "2022-01-30 14:01:35",
      "updated_at": "2022-01-30 14:01:17",
      "deleted_at": null
    },
    {
      "id": 4,
      "description": "new bulk",
      "created_at": "2022-01-30 14:01:41",
      "updated_at": "2022-01-30 14:01:41",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 4,
      "count": 4,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/depot-types

This endpoint will allow you to get the depot types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/depot-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/depot-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:10, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/depot-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/depot-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/depot-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/depot-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:10, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/depot-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/depot-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/depot-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/depot-types/export

This endpoint will allow you to Export the depot-types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/depot-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/depot-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Designations

Resources related to maintenance in the API.

Designations is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/designations
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "MANAGING D",
      "created_at": "2022-01-30 15:01:58",
      "updated_at": "2022-01-30 15:01:58",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/designations

This endpoint will allow you to get the designations in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/designations
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/designations

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:50, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/designations/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/designations/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/designations
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/designations

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:50, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/designations/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/designations/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:50, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/designations/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/designations/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/designations/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/designations/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Note Types

Resources related to maintenance in the API.

Note Types API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/note-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/note-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/note-types

This endpoint will allow you to get the Note Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/note-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/note-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/note-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/note-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/note-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/note-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/note-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/note-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/note-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Note-Types.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/note-types/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/note-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/note-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Eta Service Providers

Resources related to maintenance in the API.

Eta Service Providers is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/eta-service-providers
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "BTS ROODEPOORT",
      "email": "niel@vulindlela.com",
      "created_at": "2022-01-31 09:01:06",
      "updated_at": "2022-01-31 09:01:06",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/eta-service-providers

This endpoint will allow you to get the eta service providers in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/eta-service-providers
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa","email":"tester1@tester.co.za"},
    {"ref_key":"222","description":"Description Bbbb","email":"tester1@tester.co.za"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/eta-service-providers

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

  3. email (string, max:50, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/eta-service-providers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/eta-service-providers/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/eta-service-providers
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B","email":"tester1@tester.co.za"},
    {"ref_key":"test","id":"3","description":"Description Aaaa","email":"tester2@tester.co.za"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/eta-service-providers

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:10, optional) This is the column you want to update

  4. email (string, max:50, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/eta-service-providers/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/eta-service-providers/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

  3. email (string, max:50, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/eta-service-providers/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/eta-service-providers/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/eta-service-providers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/eta-service-providers/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Location Types

Resources related to maintenance in the API.

Location Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/location-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Head Office",
      "created_at": "2022-01-31 13:01:20",
      "updated_at": "2022-01-31 13:01:20",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/location-types

This endpoint will allow you to get the location types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/location-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/location-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:10, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/location-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/location-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/location-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/location-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:10, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/location-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/location-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/location-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Location-Types-2022-01-31-14-07-54.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/location-types/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/location-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/location-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Market Segment

Resources related to maintenance in the API.

Market Segment is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/market-segments
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "BUS",
      "created_at": "2022-01-31 16:01:31",
      "updated_at": "2022-01-31 16:01:31",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/market-segments

This endpoint will allow you to get the market segments in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/market-segments
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/market-segments

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:25, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/market-segments/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/market-segments/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/market-segments
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/market-segments

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:25, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/market-segments/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/market-segments/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:25, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/market-segments/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/market-segments/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/market-segments/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/market-segments/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Customer Super Group

Resources related to maintenance in the API.

Customer Super Group is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/customer-super-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/customer-super-groups?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/customer-super-groups

This endpoint will allow you to get the Customer Super Group in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/customer-super-groups/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/customer-super-groups/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/customer-super-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/customer-super-groups/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/customer-super-groups/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/customer-super-groups/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/customer-super-groups/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/customer-super-groups/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/customer-super-groups/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/customer-super-groups/export

This endpoint will allow you to Export the Customer Super Group information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/customer-super-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/customer-super-groups/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/customer-super-groups/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/customer-super-groups/list

This endpoint will allow you to list a record

Customer Depots

Resources related to maintenance in the API.

Customer Depots is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/customer-depots
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 2,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "customer_super_group": {
        "id": 99,
        "description": "Dummy Text",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 3,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "customer_super_group": {
        "id": 100,
        "description": "Dummy Text",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 4,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "customer_super_group": {
        "id": 102,
        "description": "Dummy Text",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 5,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "customer_super_group": {
        "id": 103,
        "description": "Dummy Text",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 1,
      "description": "Dummy Text",
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "customer_super_group": {
        "id": 98,
        "description": "Dummy Text",
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 5,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/customer-depots

This endpoint will allow you to get the Customer Depots in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“customer_groups_id”: “asc”},
    • {“description”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/customer-depots/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        { "ref_key" : "abc", "description" : "test", "customer_groups_id" : "7"},
        {"ref_key" : "tex", "description" : "test", "customer_groups_id" : "8"}
     ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "description": "Dummy text",
      "customer_groups_id": 1,
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "description": "Dummy text",
      "customer_groups_id": 1,
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/customer-depots/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. customer_groups_id (numeric, required) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/customer-depots/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Dummy Text",
    "deleted_at": "",
    "created_at": "2022-01-27 17:01:31",
    "updated_at": "2022-01-27 17:01:31",
    "customer_super_group": {
      "id": 98,
      "description": "Dummy Text",
      "created_at": "2022-01-27 17:01:13",
      "updated_at": "2022-01-27 17:01:13"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/customer-depots/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/customer-depots/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    { "ref_key" : "abc","id": "3","customer_groups_id":"1", "description" : "why1"},
    { "ref_key" : "233", "id": "4","customer_groups_id":"8",  "description" : "why2"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/customer-depots/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. customer_groups_id (email, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/customer-depots/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/customer-depots/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. customer_groups_id (numeric, required) if not supplied, an error will occur

  3. description (string, required) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/customer-depots/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/customer-depots/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/customer-depots/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/customer-depots/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Customer Services

Resources related to maintenance in the API.

Customer Services is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/customer-services
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/customer-services?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/customer-services

This endpoint will allow you to get the customer-services in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/customer-services/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/customer-services/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/customer-services/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/customer-services/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/customer-services/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/customer-services/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/customer-services/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/customer-services/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/customer-services/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/customer-services/export

This endpoint will allow you to Export the customer-services information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/customer-services/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/customer-services/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Payment Terms

Resources related to maintenance in the API.

Payment Terms API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/payment-terms
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/payment-terms?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/payment-terms

This endpoint will allow you to get the Payment Terms in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/payment-terms/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/payment-terms/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/payment-terms/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/payment-terms/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/payment-terms/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/payment-terms/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/payment-terms/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/payment-terms/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/payment-terms/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Note-Types.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/payment-terms/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/payment-terms/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/payment-terms/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Order Form Item Type

Resources related to maintenance in the API.

Order Form Item Type is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/order-form-item-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Manufactured",
      "created_at": "2022-02-01 15:02:43",
      "updated_at": "2022-02-01 15:02:43",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/order-form-item-types

This endpoint will allow you to get the order form item type in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/order-form-item-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/order-form-item-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/order-form-item-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/order-form-item-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/order-form-item-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/order-form-item-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/order-form-item-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/order-form-item-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/order-form-item-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Order-Form-Item-Types-2022-02-01-15-09-17.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/order-form-item-types/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/order-form-item-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/order-form-item-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/order-form-item-types/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/order-form-item-types/list

This endpoint will allow you to list a record

Order Form Item Groups

Resources related to maintenance in the API.

Order Form Item Groups is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/order-form-item-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 2,
      "code": "",
      "description": "Description new bulk",
      "created_at": "2022-02-01 12:02:49",
      "updated_at": "2022-02-01 12:02:49",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/order-form-item-groups

This endpoint will allow you to get the Order Form Item Groups in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/order-form-item-groups
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/order-form-item-groups

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. code (string, max:3, required) This is the column you want to update

  3. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/order-form-item-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/order-form-item-groups/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/order-form-item-groups
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","code":"111","description":"Description B"},
    {"ref_key":"test","id":"3","code":"222","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/order-form-item-groups

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. code (string, max:3, required) This is the column you want to update

  4. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/order-form-item-groups/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/order-form-item-groups/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. code (string, max:3, required) This is the column you want to update

  3. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/order-form-item-groups/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Order-Form-Item-Groups-2022-02-01-12-57-37.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/order-form-item-groups/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/order-form-item-groups/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/order-form-item-groups/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Order Form Consumable Type

Resources related to maintenance in the API.

Order Form Consumable Type is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "ENVELOPES",
      "created_at": "2022-02-01 15:02:08",
      "updated_at": "2022-02-01 15:02:08",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/order-form-consumable-types

This endpoint will allow you to get the order form consumable type in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/order-form-consumable-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:40, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/order-form-consumable-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/order-form-consumable-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:40, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/order-form-consumable-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:40, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Order-Form-Consumable-Type-2022-02-01-16-04-03.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/order-form-consumable-types/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/order-form-consumable-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/order-form-consumable-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Ratings

Resources related to maintenance in the API.

Ratings API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/ratings
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ratings?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/ratings

This endpoint will allow you to get the Ratings in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/ratings/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/ratings/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/ratings/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/ratings/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/ratings/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/ratings/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/ratings/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/ratings/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/ratings/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Note-Types.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/ratings/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/ratings/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/ratings/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

System Application

Resources related to maintenance in the API.

System Application is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/system-applications
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "mods": "Dummy Text",
      "order_num": 123,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "mods": "Dummy Text",
      "order_num": 123,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/system-applications?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/system-applications

This endpoint will allow you to get the System Application in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“mods”: “asc”},
    • {“order_num”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/system-applications/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "111", "description": "Dummy Text", "mods": "Dummy Text", "order_num": "123"},
    {"ref_key": "222", "description": "Dummy Text", "mods": "Dummy Text", "order_num": "123"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/system-applications/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/system-applications/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "mods": "Dummy Text",
    "order_num": 123,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/system-applications/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/system-applications/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text", "mods": "Dummy Text", "order_num": "123"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text", "mods": "Dummy Text", "order_num": "123"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/system-applications/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:25, optional) This is the column you want to update

  4. mods (string, max:20, optional) This is the column you want to update

  5. order_num (integer, max:3, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/system-applications/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/system-applications/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

  3. mods (string, max:20, optional) This is the column you want to update

  4. order_num (integer, max:3, optional) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/system-applications/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/SystemApplications-2022-01-17 09:20:07.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/system-applications/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“mods”: “asc”},
    • {“order_num”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/system-applications/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/system-applications/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/system-applications/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/system-applications/list

This endpoint will allow you to list a record

Reports

Resources related to maintenance in the API.

Reports is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/reports
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 2,
      "description": "Dummy Text",
      "order_num": 123,
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "system_application": {
        "id": 99,
        "description": "Dummy Text",
        "mods": "Dummy Text",
        "order_num": 123,
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 3,
      "description": "Dummy Text",
      "order_num": 123,
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "system_application": {
        "id": 100,
        "description": "Dummy Text",
        "mods": "Dummy Text",
        "order_num": 123,
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 4,
      "description": "Dummy Text",
      "order_num": 123,
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "system_application": {
        "id": 102,
        "description": "Dummy Text",
        "mods": "Dummy Text",
        "order_num": 123,
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 5,
      "description": "Dummy Text",
      "order_num": 123,
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "system_application": {
        "id": 103,
        "description": "Dummy Text",
        "mods": "Dummy Text",
        "order_num": 123,
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    },
    {
      "id": 1,
      "description": "Dummy Text",
      "order_num": 123,
      "deleted_at": "",
      "created_at": "2022-01-27 17:01:31",
      "updated_at": "2022-01-27 17:01:31",
      "system_application": {
        "id": 98,
        "description": "Dummy Text",
        "mods": "Dummy Text",
        "order_num": 123,
        "created_at": "2022-01-27 17:01:13",
        "updated_at": "2022-01-27 17:01:13"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 5,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/reports

This endpoint will allow you to get the Reports in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“system_applications_id”: “asc”},
    • {“description”: “asc”},
    • {“order_num”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/reports/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "system_applications_id":1, "description":"Dummy Text", "system_applications_id": 1, "order_num": 123 },
    {"ref_key":"112", "system_applications_id":1,"description":"Dummy Text", "system_applications_id": 1, "order_num": 123 },
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
    "data": [
        {
            "description": "Dummy text",
            "system_applications_id": 1,
            "order_num": 123,
            "created_at": "2022-02-01 17:02:32",
            "updated_at": "2022-02-01 17:02:32",
        },
        {
            "description": "Dummy text",
            "system_applications_id": 1,
            "order_num": 123,
            "created_at": "2022-02-01 17:02:32",
            "updated_at": "2022-02-01 17:02:32",
        }
    ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/reports/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. system_applications_id (int, required) This is the column you want to store

  4. order_num (int, nullable) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/reports/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 3,
    "description": "Dummy Text",
    "order_num": 1,
    "deleted_at": "",
    "created_at": "2022-02-01 12:02:45",
    "updated_at": "2022-02-01 12:02:45",
    "system_application": {
      "id": 1,
      "description": "Dummy Text",
      "order_num": 123,
      "created_at": "2022-02-01 12:02:01",
      "updated_at": "2022-02-01 12:02:01"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/reports/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/reports/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "id": 1, "description":"Dummy Text", "system_applications_id": 1, "order_num": "123" },
    {"ref_key":"112", "id": "2", "description":"Dummy Text", "system_applications_id": 1, "order_num": "123" },
    ]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/reports/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. system_applications_id (int, required) This is the column you want to update

  5. order_num (int, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/reports/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/reports/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. system_applications_id (numeric, required) if not supplied, an error will occur

  3. description (string, required) required for new record

  4. order_num (int, required) required for new record or update

Export

POST https://laravel.bandag.zerobox.co.za/api/reports/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/reports/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/reports/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/reports/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Required Dealer Capabilities

Resources related to maintenance in the API.

Required Dealer Capabilities is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/required-dealer-capabilities

This endpoint will allow you to get the Applications in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "111", "description": "Dummy Text"},
    {"ref_key": "222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/required-dealer-capabilities/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/required-dealer-capabilities/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/required-dealer-capabilities/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/required-dealer-capabilities/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/required-dealer-capabilities/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/required-dealer-capabilities/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/required-dealer-capabilities/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Order Form Retread Consumable

Resources related to maintenance in the API.

Order Form Retread Consumable is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "order_form_item_types_id": 1,
      "order_form_item_types_title": "Manufactured",
      "order_form_consumable_types_id": 3,
      "order_form_consumable_types_title": "CUSHION - BONDING",
      "order_form_item_number": "1103104",
      "order_form_item_description": "1\" STRIP",
      "order_form_item_unit_weight": 0.999,
      "updated_at": "2022-02-02 17:02:11",
      "deleted_at": null
    },
    {
      "id": 2,
      "order_form_item_types_id": 1,
      "order_form_item_types_title": "Manufactured",
      "order_form_consumable_types_id": 3,
      "order_form_consumable_types_title": "CUSHION - BONDING",
      "order_form_item_number": "1103022",
      "order_form_item_description": "2\" STRIP CUSHION",
      "order_form_item_unit_weight": 0.999,
      "updated_at": "2022-02-02 17:02:11",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/order-form-retread-consumables

This endpoint will allow you to get the Order Form Retread Consumable in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“order_form_item_number”: “asc”},
    • {“order_form_item_description”: “asc”},
    • {“order_form_item_unit_weight”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","order_form_item_types_id":"15","description":"Description Aaaa"},
    {"ref_key":"222","order_form_item_types_id":"15","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/order-form-retread-consumables

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

  3. Or they can go under Body >> raw tab (type: JSON) on postman

    • It will have to be a valid json format (verify your json here)

records

  1. ref_key (string, required) This is the unique identifier key

  2. order_form_item_types_id (numeric, required) This is the column you want to update

    • must exist in table order_form_item_types

  3. order_form_consumable_types_id (numeric, required) This is the column you want to update

    • must exist in table order_form_consumable_types

  4. order_form_item_number (string, max:20, required) This is the column you want to update

  5. order_form_item_description (string, max:120, required) This is the column you want to update

  6. order_form_item_unit_weight (numeric, required) This is the column you want to update

  7. product_price_excl (numeric, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "description Aaaaa",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/order-form-retread-consumables/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"1","order_form_item_types_id":"15","order_form_item_number":"Code A","order_form_item_description":"Description Aaaa","order_form_item_unit_weight": "1","product_price_excl": "150"},
    {"ref_key":"333","id":"2","order_form_item_types_id":"15","order_form_item_number":"Code B","order_form_item_description":"Description Bbbb","order_form_item_unit_weight": "1","product_price_excl": "100"},
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/order-form-retread-consumables

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. order_form_item_types_id (numeric, required) This is the column you want to update

    • must exist in table order_form_item_types

  3. order_form_consumable_types_id (numeric, required) This is the column you want to update

    • must exist in table order_form_consumable_types

  4. order_form_item_number (string, max:20, required) This is the column you want to update

  5. order_form_item_description (string, max:120, required) This is the column you want to update

  6. order_form_item_unit_weight (numeric, required) This is the column you want to update

  7. product_price_excl (numeric, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/order-form-retread-consumables/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. order_form_item_types_id (numeric, required) This is the column you want to update

    • must exist in table order_form_item_types

  3. order_form_consumable_types_id (numeric, required) This is the column you want to update

    • must exist in table order_form_consumable_types

  4. order_form_item_number (string, max:20, required) This is the column you want to update

  5. order_form_item_description (string, max:120, required) This is the column you want to update

  6. order_form_item_unit_weight (numeric, required) This is the column you want to update

    • if order_form_item_unit_weight is 1 then product_price_excl will be set to 0

  7. product_price_excl (numeric, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Ancillary-Products.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/order-form-retread-consumables/export

This endpoint will allow you to Export the order-form-retread-consumables information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/order-form-retread-consumables/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

List Record

GET https://laravel.bandag.zerobox.co.za/api/order-form-retread-consumables/list
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200422401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "description": "Testing Cccc",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",
        "deleted_at": "2022-01-20 20:01:36"
    },
    {
        "id": 7,
        "description": "Testing DDD",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
],
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Record
GET/api/order-form-retread-consumables/list

This endpoint will allow you to list a record

Required Services

Resources related to maintenance in the API.

Required Services API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/required-services
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/required-services?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/required-services

This endpoint will allow you to get the Required Services in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/required-services/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/required-services/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/required-services/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/required-services/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/required-services/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/required-services/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/required-services/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/required-services/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/required-services/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Required-Services.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/required-services/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/required-services/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/required-services/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Required Programs

Resources related to maintenance in the API.

Required Programs API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/required-programs
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/required-programs?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/required-programs

This endpoint will allow you to get the Required Programs in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/required-programs/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/required-programs/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/required-programs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/required-programs/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/required-programs/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/required-programs/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/required-programs/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/required-programs/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/required-programs/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/RequiredPrograms-2022-02-02-20-31-24.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/required-programs/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/required-programs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/required-programs/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Retread Brands

Resources related to maintenance in the API.

Retread Brands API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/retread-brands
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "code": "123",
      "popular": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "code": "123",
      "popular": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/retread-brands?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/retread-brands

This endpoint will allow you to get the Retread Brands in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/retread-brands/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text", "code": "123", "popular": 1},
    {"ref_key":"222","description":"Dummy Text", "code": "123", "popular": 1},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/retread-brands/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:255, required) This is the retread brand description

  3. code (string, max:5, required) This is the retread brand code

  4. popular (numeric, max:1) Flag retread brand as popular or not

Show

GET https://laravel.bandag.zerobox.co.za/api/retread-brands/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "code": "123",
    "popular": 0,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/retread-brands/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/retread-brands/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "id":"2", "description":"Dummy Text", "code": "123", "popular": 1},
    {"ref_key":"222", "id":"1", "description":"Dummy Text", "code": "123", "popular": 1},
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/retread-brands/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/retread-brands/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/retread-brands/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/retread-brands/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Retread-Brands.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/retread-brands/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/retread-brands/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/retread-brands/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

SAF Turbo Tyre Problems

Resources related to maintenance in the API.

SAF Turbo Tyre Problems is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "code": "209",
      "description": "Damaged Valve",
      "is_secondary": 0,
      "created_at": "2022-02-03 07:02:55",
      "updated_at": "2022-02-03 07:02:55",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-tyre-problems

This endpoint will allow you to get the SAF Turbo Tyre Problems in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“code”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-tyre-problems

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. code (string, max:10, required) This is the column you want to update

  3. description (string, max:52, required) This is the column you want to update

  4. is_secondary (numeric, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "code": "209",
    "description": "Damaged Valve",
    "is_secondary": 0,
    "created_at": "2022-02-03 07:02:55",
    "updated_at": "2022-02-03 07:02:55",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-tyre-problems/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"1","code":"Code A","description":"Description Aaaa","is_secondary": "1"},
    {"ref_key":"333","id":"2","code":"Code B","description":"Description Bbbb","is_secondary": "1"},
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-tyre-problems

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. code (string, max:10, required) This is the column you want to update

  3. description (string, max:52, required) This is the column you want to update

  4. is_secondary (numeric, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-tyre-problems/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. code (string, max:10, required) This is the column you want to update

  3. description (string, max:52, required) This is the column you want to update

  4. is_secondary (numeric, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Ancillary-Products.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-tyre-problems/export

This endpoint will allow you to Export the saf-tyre-problems information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-tyre-problems/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Sales Approach

Resources related to maintenance in the API.

Sales Approach is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/sales-approaches
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/sales-approaches

This endpoint will allow you to get the Sales Approach in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/sales-approaches
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/sales-approaches

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:25, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/sales-approaches/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/sales-approaches/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/sales-approaches
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/sales-approaches

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:25, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/sales-approaches/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/sales-approaches/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:25, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/sales-approaches/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/sales-approaches/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/sales-approaches/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/sales-approaches/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

SAF - Benchmark

Resources related to maintenance in the API.

SAF - Benchmark is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-benchmarks
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "value": 1,
      "order_num": 1,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "value": 1,
      "order_num": 1,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/SAF - Benchmark?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-benchmarks

This endpoint will allow you to get the SAF - Benchmark in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“value”: “asc”},
    • {“order_num”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-benchmarks/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[{ "ref_key" : "abc", "description" : "test", "value" : "4", "order_num": "1,"}, {"ref_key" : "tex", "description" : "test", "value" : "4", "order_num": "1"}]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-benchmarks/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-benchmarks/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "value": 1,
    "order_num": 1,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-benchmarks/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-benchmarks/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[{ "ref_key" : "abc","id": "3", "description" : "test", "value" : "4", "order_num": "1,"},{ "ref_key" : "233", "id": "4", "description" : "test", "value" : "4", "order_num": "1,"}]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-benchmarks/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-benchmarks/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-benchmarks/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

  3. value (float, max:30, optional) required for new record

  4. order_num (int, max:1, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-benchmarks/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-benchmarks/export

This endpoint will allow you to Export the SAF - Benchmark information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“value”: “asc”},
    • {“order_num”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-benchmarks/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-benchmarks/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

SAF - Categories

Resources related to maintenance in the API.

SAF - Categories is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "value": 1,
      "order_num": 1,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "value": 1,
      "order_num": 1,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/saf-categories?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-categories

This endpoint will allow you to get the SAF - Categories in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“value”: “asc”},
    • {“order_num”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-categories/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[{ "ref_key" : "abc", "description" : "test", "value" : "4", "order_num": "1,"}, {"ref_key" : "tex", "description" : "test", "value" : "4", "order_num": "1"}]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-categories/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "value": 1,
    "order_num": 1,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-categories/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[{ "ref_key" : "abc","id": "3", "description" : "test", "value" : "4", "order_num": "1,"},{ "ref_key" : "233", "id": "4", "description" : "test", "value" : "4", "order_num": "1,"}]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-categories/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-categories/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

  3. value (float, max:30, optional) required for new record

  4. order_num (int, max:1, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-categories/export

This endpoint will allow you to Export the SAF - Categories information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“value”: “asc”},
    • {“order_num”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

SAF - Check - Questions

Resources related to maintenance in the API.

SAF - Check - Questions is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-check-questions
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:47",
      "updated_at": "2022-02-02 22:02:47",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 2,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:47",
      "updated_at": "2022-02-02 22:02:47",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 3,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:56",
      "updated_at": "2022-02-02 22:02:56",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 4,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:56",
      "updated_at": "2022-02-02 22:02:56",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 5,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:57",
      "updated_at": "2022-02-02 22:02:57",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 6,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:57",
      "updated_at": "2022-02-02 22:02:57",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:58",
      "updated_at": "2022-02-02 22:02:58",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 8,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:58",
      "updated_at": "2022-02-02 22:02:58",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 9,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:00",
      "updated_at": "2022-02-02 22:02:00",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    },
    {
      "id": 10,
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": 1,
      "deleted_at": "",
      "created_at": "2022-02-02 22:02:00",
      "updated_at": "2022-02-02 22:02:00",
      "saf_categories": {
        "id": 1,
        "value": "Dummy Text",
        "order_num": 1,
        "created_at": "2022-02-02 22:02:47",
        "updated_at": "2022-02-02 22:02:47"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 10,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-check-questions

This endpoint will allow you to get the SAF - Check - Questions in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“saf_categories_id”: “asc”},
    • {“description”: “asc”},
    • {“action”: “asc”},
    • {“attendedto”: “asc”},
    • {“weight”: “asc”},
    • {“order_num”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-check-questions/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
        {"ref_key" : "abc", "saf_categories_id": "1", "description": "Dummy Text", "value": "4", "action": "Dummy Text", "attendedto": "Dummy Text", "weight": "Dummy Text", "order_num": "1"},
        {"ref_key" : "tex", "saf_categories_id": "1", "description" : "Dummy Text", "value": "4", "action": "Dummy Text", "attendedto": "Dummy Text", "weight": "Dummy Text", "order_num": "1"}
        ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "saf_categories_id": "1",
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": "1",
      "created_at": "2022-02-02T22:20:00.110523Z",
      "updated_at": "2022-02-02T22:20:00.110545Z"
    },
    {
      "saf_categories_id": "1",
      "description": "Dummy Text",
      "action": "Dummy Text",
      "attendedto": "Dummy Text",
      "weight": "Dummy Text",
      "order_num": "1",
      "created_at": "2022-02-02T22:20:00.110559Z",
      "updated_at": "2022-02-02T22:20:00.110569Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-check-questions/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. saf_categories_id (int, required) This is the column you want to store

  4. action (int, required) This is the column you want to store

  5. attendedto (int, required) This is the column you want to store

  6. weight (int, required) This is the column you want to store

  7. order_num (int, nullable) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-check-questions/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 3,
    "description": "Dummy Text",
    "action": "Dummy Text",
    "attendedto": "Dummy Text",
    "weight": "Dummy Text",
    "order_num": 1,
    "deleted_at": "",
    "created_at": "2022-02-02 22:02:56",
    "updated_at": "2022-02-02 22:02:56",
    "saf_categories": {
      "id": 1,
      "value": "Dummy Text",
      "order_num": 1,
      "created_at": "2022-02-02 22:02:47",
      "updated_at": "2022-02-02 22:02:47"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-check-questions/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-check-questions/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[{ "ref_key" : "abc","id": "3", "saf_categories_id": "1", "description": "test", "value": "4", "action": "Dummy Text", "attendedto": "Ready Text", "weight": "Dummy Text", "order_num": "1"},{ "ref_key" : "233", "id": "4", "saf_categories_id": "1", "description": "test", "value": "4", "action": "Dummy Text", "attendedto": "Dummy Text", "weight": "Dummy Text", "order_num": "1"}]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-check-questions/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to store

  4. action (string, required) This is the column you want to store

  5. attendedto (string, required) This is the column you want to store

  6. weight (string, required) This is the column you want to store

  7. order_num (int, nullable) This is the column you want to store

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-check-questions/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-check-questions/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. saf_categories_id (numeric, required) if not supplied, an error will occur

  3. description (string, required) This is the column you want to store

  4. action (string, required) This is the column you want to store

  5. attendedto (string, required) This is the column you want to store

  6. weight (string, required) This is the column you want to store

  7. order_num (int, nullable) This is the column you want to store

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-check-questions/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-check-questions/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-check-questions/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-check-questions/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Retread Designs

Resources related to maintenance in the API.

Retread Designs API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/retread-designs
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "code": "123",
      "description": "Dummy Text",
      "original_tread_depth": 17.5,
      "pic": "retread_design_20090615031938_udr.jpg",
      "popular": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "code": "122",
      "description": "Dummy Text",
      "original_tread_depth": 22.5,
      "pic": "retread_design_20090615031938_udr11.jpg",
      "popular": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/retread-designs?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/retread-designs

This endpoint will allow you to get the Retread Designs in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/retread-designs/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","code":"123","description":"Dummy Text", "original_tread_depth": 22.50, "pic": "retread_design_20090615031938_udr.jpg","popular": 1},
    {"ref_key":"111","code":"433","description":"Dummy Text", "original_tread_depth": 18.50, "pic": "retread_design_20090615031938_udr232.jpg","popular": 1}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/retread-designs/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:255, required) This is the retread brand description

  3. code (string, max:5, required) This is the retread brand code

  4. popular (numeric, max:1) Flag retread brand as popular or not

Show

GET https://laravel.bandag.zerobox.co.za/api/retread-designs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "code": "122",
    "description": "Dummy Text",
    "original_tread_depth": 22.5,
    "pic": "retread_design_20090615031938_udr11.jpg",
    "popular": 0,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/retread-designs/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/retread-designs/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","id": 1, "code":"123","description":"Dummy Text", "original_tread_depth": 22.50, "pic": "retread_design_20090615031938_udr.jpg","popular": 1},
    {"ref_key":"111","id": 2, "code":"433","description":"Dummy Text", "original_tread_depth": 18.50, "pic": "retread_design_20090615031938_udr232.jpg","popular": 1}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/retread-designs/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/retread-designs/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/retread-designs/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/retread-designs/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Retread-Designs.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/retread-designs/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/retread-designs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/retread-designs/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Service Frequencies

Resources related to maintenance in the API.

Service Frequencies API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/service-frequencies
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/service-frequencies?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/service-frequencies

This endpoint will allow you to get the Service Frequencies in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/service-frequencies/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/service-frequencies/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/service-frequencies/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/service-frequencies/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/service-frequencies/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/service-frequencies/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/service-frequencies/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/service-frequencies/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/service-frequencies/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/ServiceFrequencies-2022-02-04-20-23-12.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/service-frequencies/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/service-frequencies/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/service-frequencies/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

SAF Turbo Tyre Problems

Resources related to maintenance in the API.

SAF Turbo Tyre Problems is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "code": "209",
      "description": "Damaged Valve",
      "is_secondary": 0,
      "created_at": "2022-02-03 07:02:55",
      "updated_at": "2022-02-03 07:02:55",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-tyre-problems

This endpoint will allow you to get the SAF Turbo Tyre Problems in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“code”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-tyre-problems

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. code (string, max:10, required) This is the column you want to update

  3. description (string, max:52, required) This is the column you want to update

  4. is_secondary (numeric, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "code": "209",
    "description": "Damaged Valve",
    "is_secondary": 0,
    "created_at": "2022-02-03 07:02:55",
    "updated_at": "2022-02-03 07:02:55",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-tyre-problems/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"1","code":"Code A","description":"Description Aaaa","is_secondary": "1"},
    {"ref_key":"333","id":"2","code":"Code B","description":"Description Bbbb","is_secondary": "1"},
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-tyre-problems

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. code (string, max:10, required) This is the column you want to update

  3. description (string, max:52, required) This is the column you want to update

  4. is_secondary (numeric, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-tyre-problems/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. code (string, max:10, required) This is the column you want to update

  3. description (string, max:52, required) This is the column you want to update

  4. is_secondary (numeric, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Ancillary-Products.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-tyre-problems/export

This endpoint will allow you to Export the saf-tyre-problems information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-tyre-problems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-tyre-problems/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Retread Designs

Resources related to maintenance in the API.

Retread Designs API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/retread-designs
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "code": "123",
      "description": "Dummy Text",
      "original_tread_depth": 17.5,
      "pic": "retread_design_20090615031938_udr.jpg",
      "popular": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "code": "122",
      "description": "Dummy Text",
      "original_tread_depth": 22.5,
      "pic": "retread_design_20090615031938_udr11.jpg",
      "popular": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/retread-designs?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/retread-designs

This endpoint will allow you to get the Retread Designs in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/retread-designs/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","code":"123","description":"Dummy Text", "original_tread_depth": 22.50, "pic": "retread_design_20090615031938_udr.jpg","popular": 1},
    {"ref_key":"111","code":"433","description":"Dummy Text", "original_tread_depth": 18.50, "pic": "retread_design_20090615031938_udr232.jpg","popular": 1}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/retread-designs/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:255, required) This is the retread brand description

  3. code (string, max:5, required) This is the retread brand code

  4. popular (numeric, max:1) Flag retread brand as popular or not

Show

GET https://laravel.bandag.zerobox.co.za/api/retread-designs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "code": "122",
    "description": "Dummy Text",
    "original_tread_depth": 22.5,
    "pic": "retread_design_20090615031938_udr11.jpg",
    "popular": 0,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/retread-designs/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/retread-designs/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","id": 1, "code":"123","description":"Dummy Text", "original_tread_depth": 22.50, "pic": "retread_design_20090615031938_udr.jpg","popular": 1},
    {"ref_key":"111","id": 2, "code":"433","description":"Dummy Text", "original_tread_depth": 18.50, "pic": "retread_design_20090615031938_udr232.jpg","popular": 1}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/retread-designs/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/retread-designs/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/retread-designs/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/retread-designs/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Retread-Designs.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/retread-designs/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/retread-designs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/retread-designs/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Truck Types

Resources related to maintenance in the API.

Truck Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/truck-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "code": "SA001",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "code": "SA001",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/truck-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/truck-types

This endpoint will allow you to get the Truck Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“code”: “SA001”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/truck-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        {"ref_key":"111", "description":"Dummy Text", "code": "SA001" },
        {"ref_key":"112", "description":"Dummy Text", "code": "SA001" },
    ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "code": "SA001",
      "description": "Dummy Text",
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "code": "SA001",
      "description": "Dummy Text",
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/truck-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. code (string, required) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/truck-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "code": "SA001",
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/truck-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/truck-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "description": "Dummy Text", "code": "SA001" },
    {"ref_key":"112", "description": "Dummy Text", "code": "SA001" },
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/truck-types/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. code (email, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/truck-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/truck-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) required for new record

  3. code (string, required) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/truck-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/AreaOfOpportunity-2022-01-27-13-38-43.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/truck-types/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. example@domain.co.za Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/truck-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/truck-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tread Rubbers

Resources related to maintenance in the API.

Tread Rubbers is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tread-rubbers
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "exclude_for_current_customer": 1,
      "exclude_from_percentages_procost": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "exclude_for_current_customer": 1,
      "exclude_from_percentages_procost": 0,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tread-rubbers?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tread-rubbers

This endpoint will allow you to get the Tread Rubbers in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“exclude_for_current_customer”: “asc”},
    • {“exclude_from_percentages_procost”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tread-rubbers/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

   {
   "records":[
       { "ref_key" : "abc", "description" : "test", "exclude_for_current_customer" : "1", "exclude_from_percentages_procost": "0"},
       {"ref_key" : "tex", "description" : "test", "exclude_for_current_customer" : "1", "exclude_from_percentages_procost": "0"}
       ]
   }
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "description": "Dummy Text",
      "exclude_for_current_customer": 1,
      "exclude_from_percentages_procost": 0,
      "created_at": "2022-02-04T13:59:44.710475Z",
      "updated_at": "2022-02-04T13:59:44.710487Z"
    },
    {
      "description": "Dummy Text",
      "exclude_for_current_customer": 1,
      "exclude_from_percentages_procost": 0,
      "created_at": "2022-02-04T13:59:44.710503Z",
      "updated_at": "2022-02-04T13:59:44.710510Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tread-rubbers/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. exclude_for_current_customer (float, required) This is the column you want to store

  4. exclude_from_percentages_procost (float, required) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/tread-rubbers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "exclude_for_current_customer": 1,
    "exclude_from_percentages_procost": 0,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tread-rubbers/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tread-rubbers/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "1",
      "description": "test",
      "exclude_for_current_customer": "1",
      "exclude_from_percentages_procost": "0"
    },
    {
      "ref_key": "tex",
      "id": "2",
      "description": "test",
      "exclude_for_current_customer": "1",
      "exclude_from_percentages_procost": "0"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tread-rubbers/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. exclude_for_current_customer (float, required) This is the column you want to store

  5. exclude_from_percentages_procost (float, required) This is the column you want to store

Import

POST https://laravel.bandag.zerobox.co.za/api/tread-rubbers/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tread-rubbers/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) required for new record

  3. exclude_for_current_customer (float, required) This is the column you want to store

  4. exclude_from_percentages_procost (float, required) This is the column you want to store

Export

POST https://laravel.bandag.zerobox.co.za/api/tread-rubbers/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/AreaOfOpportunity-2022-01-27-13-38-43.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tread-rubbers/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. example@domain.co.za Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tread-rubbers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tread-rubbers/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tread Rubber Pricing

Resources related to maintenance in the API.

Tread Rubber Pricing is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 1,
        "date": "2022-01-30",
        "price_per_kg": 12.2,
        "deleted_at": "",
        "created_at": "2022-02-04 11:02:11",
        "updated_at": "2022-02-04 14:02:14",
        "tread_rubber": {
            "id": 1,
            "description": "test",
            "exclude_for_current_customer": 1,
            "exclude_from_percentages_procost": 0,
            "created_at": "2022-02-04 11:02:11",
            "updated_at": "2022-02-04 14:02:01"
        }
    },
    {
        "id": 2,
        "date": "2022-01-30",
        "price_per_kg": 12.2,
        "deleted_at": "",
        "created_at": "2022-02-04 11:02:11",
        "updated_at": "2022-02-04 14:02:14",
        "tread_rubber": {
            "id": 1,
            "description": "test",
            "exclude_for_current_customer": 1,
            "exclude_from_percentages_procost": 0,
            "created_at": "2022-02-04 11:02:11",
            "updated_at": "2022-02-04 14:02:01"
        }
        }
    }
],
"meta": {
    "pagination": {
        "total": 102,
        "count": 10,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 11,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing?page=2",
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tread-rubber-pricing

This endpoint will allow you to get the Tread Rubber Pricing in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“tread_rubbers_id”: “asc”},
    • {“date”: “asc”},
    • {“price_per_kg”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "tread_rubbers_id": "1",
      "date": "2022-01-30",
      "price_per_kg": "12.2"
    },
    {
      "ref_key": "tex",
      "tread_rubbers_id": "2",
      "date": "2022-02-28",
      "price_per_kg": "33.4"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "tread_rubbers_id": "1",
      "date": "2022-01-30",
      "price_per_kg": "12.2",
      "created_at": "2022-02-04T14:26:10.086398Z",
      "updated_at": "2022-02-04T14:26:10.086446Z"
    },
    {
      "tread_rubbers_id": "1",
      "date": "2022-01-30",
      "price_per_kg": "12.2",
      "created_at": "2022-02-04T14:26:10.086398Z",
      "updated_at": "2022-02-04T14:26:10.086446Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tread-rubber-pricing/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. system_applications_id (int, required) This is the column you want to store

  4. order_num (int, nullable) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "date": "2009-02-25",
    "price_per_kg": 37.34,
    "deleted_at": "",
    "created_at": "2022-02-04 11:02:11",
    "updated_at": "2022-02-04 11:02:11",
    "tread_rubber": {
      "id": 3,
      "description": "GIANT TRUCK",
      "exclude_for_current_customer": 0,
      "exclude_from_percentages_procost": 0,
      "created_at": "2022-02-04 11:02:11",
      "updated_at": "2022-02-04 11:02:11"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tread-rubber-pricing/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "1",
      "tread_rubbers_id": "1",
      "date": "2022-01-30",
      "price_per_kg": "12.2"
    },
    {
      "ref_key": "tex",
      "id": "2",
      "tread_rubbers_id": "1",
      "date": "2022-01-30",
      "price_per_kg": "12.2"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tread-rubber-pricing/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, required) This is the column you want to update

  4. system_applications_id (int, required) This is the column you want to update

  5. order_num (int, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tread-rubber-pricing/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. system_applications_id (numeric, required) if not supplied, an error will occur

  3. description (string, required) required for new record

  4. order_num (int, required) required for new record or update

Export

POST https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tread-rubber-pricing/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tread-rubber-pricing/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tread-rubber-pricing/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Dealer Categories

Resources related to maintenance in the API.

Dealer Categories API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/dealer-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/dealer-categories?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/dealer-categories

This endpoint will allow you to get the Dealer Categories in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/dealer-categories/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/dealer-categories/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/dealer-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/dealer-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/dealer-categories/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/dealer-categories/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/dealer-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/dealer-categories/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/dealer-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/DealerCategories-2022-02-04-20-23-12.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/dealer-categories/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/dealer-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/dealer-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

BCD Service Providers

Resources related to maintenance in the API.

BCD Service Providers API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/service-providers
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 3,
      "description": "Dummy Text",
      "business_hours": "08:00AM - 17:00PM",
      "physical_address": "HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO",
      "postal_address": "P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA",
      "telephone": "2646730123",
      "fax": "26467304123",
      "email": "email@test.co.za",
      "created_at": "2022-02-04 22:02:59",
      "updated_at": "2022-02-04 22:02:59",
      "deleted_at": ""
    },
    {
      "id": 4,
      "description": "Dummy Text",
      "business_hours": "08:00AM - 17:00PM",
      "physical_address": "HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO",
      "postal_address": "P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA",
      "telephone": "2646730123",
      "fax": "26467304123",
      "email": "email@test.co.za",
      "created_at": "2022-02-04 22:02:59",
      "updated_at": "2022-02-04 22:02:59",
      "deleted_at": ""
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/service-providers?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/service-providers

This endpoint will allow you to get the BCD Service Providers in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/service-providers/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text","business_hours":"08:00AM - 17:00PM","physical_address":"HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO","postal_address":"P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA","telephone":"2646730123","fax":"26467304123","email":"email@test.co.za"},
    {"ref_key":"222","description":"Dummy Text","business_hours":"08:00AM - 17:00PM","physical_address":"HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO","postal_address":"P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA","telephone":"2646730123","fax":"26467304123","email":"email@test.co.za"}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/service-providers/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/service-providers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 4,
    "description": "Dummy Text",
    "business_hours": "08:00AM - 17:00PM",
    "physical_address": "HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO",
    "postal_address": "P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA",
    "telephone": "2646730123",
    "fax": "26467304123",
    "email": "email@test.co.za",
    "created_at": "2022-02-04 22:02:59",
    "updated_at": "2022-02-04 22:02:59",
    "deleted_at": ""
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/service-providers/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/service-providers/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","id":1,"description":"Dummy Text","business_hours":"08:00AM - 17:00PM","physical_address":"HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO","postal_address":"P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA","telephone":"2646730123","fax":"26467304123","email":"email@test.co.za"},
    {"ref_key":"222","id":2,"description":"Dummy Text","business_hours":"08:00AM - 17:00PM","physical_address":"HAGE GEINGOB STREET\r\nERF NO. 13\r\nOTIJWARONGO","postal_address":"P.O. BOX 11540\r\nKLEIN WINDHOEK\r\nNAMIBIA","telephone":"2646730123","fax":"26467304123","email":"email@test.co.za"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/service-providers/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/service-providers/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/service-providers/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/service-providers/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/BcdServiceProviders-2022-02-04-20-23-12.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/service-providers/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/service-providers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/service-providers/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

BCD Service Provider Contacts

Resources related to maintenance in the API.

BCD Service Provider Contacts API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/service-provider-contacts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "designations_id": 2,
      "bcd_service_providers_id": 16,
      "contact_person": "Dummy Text",
      "tel": "011 233 2334",
      "email": "test@domain.co.za",
      "idnumber": "12345678910",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "designations_id": 3,
      "bcd_service_providers_id": 6,
      "contact_person": "Dummy Text",
      "tel": "011 544 2334",
      "email": "test@domain.co.za",
      "idnumber": "32245678910",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "http://127.0.0.1:8000/api/service-provider-contacts?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/service-provider-contacts

This endpoint will allow you to get the BCD Service Provider Contacts in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“designations_id”: “asc”},
    • {“bcd_service_providers_id”: “asc”},
    • {“contact_person”: “asc”},
    • {“tel”: “asc”},
    • {“email”: “asc”},
    • {“cell”: “asc”},
    • {“idnumber”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/service-provider-contacts/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","designations_id":3,"bcd_service_providers_id":6,"contact_person":"Dummy Text","tel":"011 544 2334","email":"test@domain.co.za","idnumber":"32245678910"},
    {"ref_key":"223","designations_id":4,"bcd_service_providers_id":12,"contact_person":"Dummy Text","tel":"011 423 3334","email":"test@domain.co.za","idnumber":"32245678910"}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/service-provider-contacts/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/service-provider-contacts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "designations_id": 3,
    "bcd_service_providers_id": 6,
    "contact_person": "Dummy Text",
    "tel": "011 544 2334",
    "email": "test@domain.co.za",
    "idnumber": "32245678910",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/service-provider-contacts/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/service-provider-contacts/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","id":2,"designations_id":44,"bcd_service_providers_id":6,"contact_person":"Dummy Text","tel":"011 544 2334","email":"test@domain.co.za","idnumber":"32245678910"},
    {"ref_key":"111","id":7,"designations_id":3,"bcd_service_providers_id":6,"contact_person":"Dummy Text","tel":"011 544 2334","email":"test@domain.co.za","idnumber":"32245678910"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/service-provider-contacts/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_service_providers_id (numeric, max:20, required) This is the Service Provider for this Contact

  4. contact_person (string, max:255, required) Name of Contact person

  5. tel (string, max:255, optional) Telephone number of Contact person

  6. email (string, max:50, optional) Email address of Contact person - must be a valid email address when supplied

  7. cell (string, max:20, optional) Cell phone number of Contact person

  8. idnumber (string, max:20, optional) ID number of Contact person

Import

POST https://laravel.bandag.zerobox.co.za/api/service-provider-contacts/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/service-provider-contacts/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/service-provider-contacts/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/ServiceFrequencies-2022-02-04-20-23-12.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/service-provider-contacts/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“designations_id”: “asc”},
    • {“bcd_service_providers_id”: “asc”},
    • {“contact_person”: “asc”},
    • {“tel”: “asc”},
    • {“email”: “asc”},
    • {“cell”: “asc”},
    • {“idnumber”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/service-provider-contacts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/service-provider-contacts/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Size Categories

Resources related to maintenance in the API.

Tyre Size Categories is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-size-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "16.5\"",
      "created_at": "2022-02-10 10:02:35",
      "updated_at": "2022-02-10 10:02:35",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-sizes-category?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-size-categories

This endpoint will allow you to get the Tyre Size Categories in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-size-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"66"},
    {"ref_key":"222","description":"99"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-size-categories

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:10, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "description": "16.5\"",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-size-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-size-categories
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"99"},
    {"ref_key":"test","id":"3","description":"66"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-size-categories

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:10, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-size-categories/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-size-categories/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-size-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Success Factors

Resources related to maintenance in the API.

Success Factors is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/success-factors
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/success-factors?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/success-factors

This endpoint will allow you to get the Success Factors in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/success-factors/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/success-factors/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/success-factors/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/success-factors/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/success-factors/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/success-factors/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/success-factors/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/success-factors/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/success-factors/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/success-factors/export

This endpoint will allow you to Export the Success Factors information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/success-factors/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/success-factors/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID
GET https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "tread_rubbers_id": 1,
      "retread_designs_id": 2,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "tread_rubbers_id": 1,
      "retread_designs_id": 2,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "tread_rubbers_id": "1",
      "retread_designs_id": "2",
      "description": "Dummy Text"
    },
    {
      "ref_key": "tex",
      "tread_rubbers_id": "1",
      "retread_designs_id": "2",
      "description": "Dummy Text"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tread-rubbers-design-link/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

  3. tread_rubbers_id (integer, required) This is the column you want to update

  4. retread_designs_id (integer, required) This is the column you want to update

GET https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "tread_rubbers_id": "1",
    "retread_designs_id": "2",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "1",
      "tread_rubbers_id": "1",
      "retread_designs_id": "2",
      "description": "Dummy Update Text"
    },
    {
      "ref_key": "tex",
      "id": "2",
      "tread_rubbers_id": "1",
      "retread_designs_id": "2",
      "description": "Dummy Update Text"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tread-rubbers-design-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

  3. tread_rubbers_id (string, required) This is the column you want to update

  4. retread_designs_id (integer, required) This is the column you want to update

POST https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/SystemApplications-2022-01-17 09:20:07.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tread-rubbers-design-link/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“tread_rubbers_id”: “asc”},
    • {“retread_designs_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/tread-rubbers-design-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Tread Sizes

Resources related to maintenance in the API.

Tread Sizes is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tread-sizes
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "cushion_weight_per_m": 14.4,
      "cushion_size": 23.5,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "cushion_weight_per_m": 14.4,
      "cushion_size": 23.5,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tread-sizes?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tread-sizes

This endpoint will allow you to get the Tread Sizes in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“cushion_weight_per_m”: “asc”},
    • {“cushion_size”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tread-sizes/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "description": "Dummy Text",
      "cushion_weight_per_m": "22.33",
      "cushion_size": "212.48"
    },
    {
      "ref_key": "tex",
      "description": "Dummy Text",
      "cushion_weight_per_m": "12.33",
      "cushion_size": "112.48"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tread-sizes/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

  3. cushion_weight_per_m (float, required) This is the column you want to update

  4. cushion_size (float, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tread-sizes/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "tread_rubbers_id": 22.3,
    "cushion_size": 33.3,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tread-sizes/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tread-sizes/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "1",
      "description": "Test Update Dummy",
      "cushion_weight_per_m": "2.33",
      "cushion_size": "123.45"
    },
    {
      "ref_key": "tex",
      "id": "2",
      "description": "Test Update Dummy",
      "cushion_weight_per_m": "1.33",
      "cushion_size": "123.45"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tread-sizes/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:25, optional) This is the column you want to update

  4. cushion_weight_per_m (float, optional) This is the column you want to update

  5. cushion_weight_per_m (float, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tread-sizes/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tread-sizes/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

  3. cushion_weight_per_m (float, required) This is the column you want to update

  4. cushion_size (float, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/tread-sizes/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/SystemApplications-2022-01-17 09:20:07.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tread-sizes/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“cushion_weight_per_m”: “asc”},
    • {“cushion_size”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tread-sizes/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tread-sizes/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tread Weights

Resources related to maintenance in the API.

Tread Weights is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tread-weights
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 3,
                    "retread_designs_id": 1,
                    "tread_sizes_id": 2,
                    "order_form_item_types_id": 1,
                    "order_form_item_groups_id": 1,
                    "truck_types_id": 2,
                    "thread_weight_per_m_kg": 1.22,
                    "orderform_item_number": 12,
                    "orderform_item_description": "Dummy Text",
                    "orderform_item_unit_weight": 1.33,
                    "exclude_from_proorder": 4,
                    "created_at": "2022-02-07 18:02:59",
                    "updated_at": "2022-02-07 18:02:59",
                    "deleted_at": ""
    },
    {
        "id": 3,
                    "retread_designs_id": ,
                    "tread_sizes_id": 2,
                    "order_form_item_types_id": 1,
                    "order_form_item_groups_id": 1,
                    "truck_types_id": 2,
                    "thread_weight_per_m_kg": 1.22,
                    "orderform_item_number": 12,
                    "orderform_item_description": "Dummy Text",
                    "orderform_item_unit_weight": 1.33,
                    "exclude_from_proorder": 4,
                    "created_at": "2022-02-07 18:02:59",
                    "updated_at": "2022-02-07 18:02:59",
                    "deleted_at": ""
    }
],
"meta": {
    "pagination": {
        "total": 8,
        "count": 8,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "prev_page_url": null,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tread-weights?page=2"
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tread-weights

This endpoint will allow you to get the Tread Weights in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“retread_designs_id”: “asc”},
    • {“tread_sizes_id”: “asc”},
    • {“order_form_item_types_id”: “asc”},
    • {“order_form_item_groups_id”: “asc”},
    • {“truck_types_id”: “asc”},
    • {“thread_weight_per_m_kg”: “asc”},
    • {“orderform_item_number”: “asc”},
    • {“orderform_item_description”: “asc”},
    • {“orderform_item_unit_weight”: “asc”},
    • {“exclude_from_proorder”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tread-weights/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "orderform_item_description": "Dummy Text",
      "retread_designs_id": "1",
      "tread_sizes_id": "2",
      "order_form_item_types_id": "1",
      "order_form_item_groups_id": "1",
      "truck_types_id": "2",
      "thread_weight_per_m_kg": "1.22",
      "orderform_item_number": "12",
      "orderform_item_unit_weight": "1.33",
      "exclude_from_proorder": "4,12"
    },
    {
      "ref_key": "tex",
      "orderform_item_description": "Dummy Text",
      "retread_designs_id": "1",
      "tread_sizes_id": "2",
      "order_form_item_types_id": "1",
      "order_form_item_groups_id": "1",
      "truck_types_id": "2",
      "thread_weight_per_m_kg": "1.22",
      "orderform_item_number": "12",
      "orderform_item_unit_weight": "1.33",
      "exclude_from_proorder": "4,12"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tread-weights/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. retread_designs_id (int, required) This is the column you want to update

  3. tread_sizes_id (int, required) This is the column you want to update

  4. order_form_item_types_id (int, required) This is the column you want to update

  5. order_form_item_groups_id (int, max:20, required) This is the column you want to update

  6. truck_types_id (int, required) This is the column you want to update

  7. thread_weight_per_m_kg (float, required) This is the column you want to update

  8. orderform_item_number (string, max:20, required) This is the column you want to update

  9. orderform_item_description (string, required) This is the column you want to update

  10. orderform_item_unit_weight (float, required) This is the column you want to update

  11. exclude_from_proorder (int, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tread-weights/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
    "data": {
                                "id": 5,
                                "retread_designs_id": ,
                                "tread_sizes_id": 2,
                                "order_form_item_types_id": 1,
                                "order_form_item_groups_id": 1,
                                "truck_types_id": 2,
                                "thread_weight_per_m_kg": 1.22,
                                "orderform_item_number": 12,
                                "orderform_item_description": "Dummy Text",
                                "orderform_item_unit_weight": 1.33,
                                "exclude_from_proorder": 4,
                                "created_at": "2022-02-07 18:02:59",
                                "updated_at": "2022-02-07 18:02:59",
                                "deleted_at": ""
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tread-weights/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tread-weights/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "1",
      "description": "Test Update Dummy",
      "cushion_weight_per_m": "2.33",
      "cushion_size": "123.45"
    },
    {
      "ref_key": "tex",
      "id": "2",
      "description": "Test Update Dummy",
      "cushion_weight_per_m": "1.33",
      "cushion_size": "123.45"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tread-weights/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. retread_designs_id (int, required) This is the column you want to update

  3. tread_sizes_id (int, required) This is the column you want to update

  4. order_form_item_types_id (int, required) This is the column you want to update

  5. order_form_item_groups_id (int, required) This is the column you want to update

  6. truck_types_id (int, required) This is the column you want to update

  7. thread_weight_per_m_kg (float, required) This is the column you want to update

  8. orderform_item_number (string, required) This is the column you want to update

  9. orderform_item_description (string, required) This is the column you want to update

  10. orderform_item_unit_weight (float, required) This is the column you want to update

  11. exclude_from_proorder (int, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tread-weights/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tread-weights/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. retread_designs_id (int, required) This is the column you want to update

  3. tread_sizes_id (int, required) This is the column you want to update

  4. order_form_item_types_id (int, required) This is the column you want to update

  5. order_form_item_groups_id (int, required) This is the column you want to update

  6. truck_types_id (int, required) This is the column you want to update

  7. thread_weight_per_m_kg (float, required) This is the column you want to update

  8. orderform_item_number (string, required) This is the column you want to update

  9. orderform_item_description (string, required) This is the column you want to update

  10. orderform_item_unit_weight (float, required) This is the column you want to update

  11. exclude_from_proorder (int, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/tread-weights/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/SystemApplications-2022-01-17 09:20:07.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tread-weights/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [ + {“id”: “asc”}, + {“retread_designs_id”: “asc”}, + {“tread_sizes_id”: “asc”}, + {“order_form_item_types_id”: “asc”}, + {“order_form_item_groups_id”: “asc”}, + {“truck_types_id”: “asc”}, + {“thread_weight_per_m_kg”: “asc”}, + {“orderform_item_number”: “asc”}, + {“orderform_item_description”: “asc”}, + {“orderform_item_unit_weight”: “asc”}, + {“exclude_from_proorder”: “asc”},

  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tread-weights/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tread-weights/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tracker Reading Types

Resources related to maintenance in the API.

Tracker Reading Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tracker-reading-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tracker-reading-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tracker-reading-types

This endpoint will allow you to get the Tracker Reading Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tracker-reading-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tracker-reading-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tracker-reading-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tracker-reading-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tracker-reading-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tracker-reading-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tracker-reading-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tracker-reading-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tracker-reading-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tracker-reading-types/export

This endpoint will allow you to Export the Tracker Reading Types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tracker-reading-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tracker-reading-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Brands

Resources related to maintenance in the API.

Tyre Brands is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-brands
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "code": "Dummy Text",
      "popular": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "code": "Dummy Text",
      "popular": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-brands?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-brands

This endpoint will allow you to get the Tyre Brands in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
    • {“popular”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-brands/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1"
    },
    {
      "ref_key": "tex",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-brands/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

  3. code (string, required) This is the column you want to update

  4. popular (string, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-brands/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "code": "Dummy Text",
    "popular": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-brands/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-brands/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "1",
      "description": "Test Update Dummy",
      "code": "SAAD",
      "popular": "1"
    },
    {
      "ref_key": "tex",
      "id": "2",
      "description": "Test Update Dummy",
      "code": "SAAD",
      "popular": "1"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-brands/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:25, optional) This is the column you want to update

  4. code (string, optional) This is the column you want to update

  5. popular (string, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-brands/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-brands/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

  3. code (string, required) This is the column you want to update

  4. popular (integer, required) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-brands/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/SystemApplications-2022-01-17 09:20:07.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-brands/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
    • {“popular”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-brands/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-brands/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Designs

Resources related to maintenance in the API.

Tyre Designs is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-designs
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 2,
        "description": "Dummy Text",
        "code": "SAAD",
        "original_tyre_depth": 12.34,
        "popular": 1,
        "deleted_at": "",
        "created_at": "2022-02-09 17:02:27",
        "updated_at": "2022-02-09 17:02:27",
        "tyre_brand": {
                "id": 1,
                "description": "Test  Dummy Update",
                "code": "SAA",
                "popular": 4,
                "created_at": "2022-02-09 17:02:22",
                "updated_at": "2022-02-09 17:02:07"
    }
},
    {
        "id": 4,
        "description": "Dummy Text",
        "code": "SAAD",
        "original_tyre_depth": 12.34,
        "popular": 1,
        "deleted_at": "",
        "created_at": "2022-02-09 17:02:27",
        "updated_at": "2022-02-09 17:02:27",
        "tyre_brand": {
                "id": 1,
                "description": "Test  Dummy Update",
                "code": "SAA",
                "popular": 4,
                "created_at": "2022-02-09 17:02:22",
                "updated_at": "2022-02-09 17:02:07"
            }
        }
    },
    {
        "id": 5,
        "description": "Dummy Text",
        "code": "SAAD",
        "original_tyre_depth": 12.34,
        "popular": 1,
        "deleted_at": "",
        "created_at": "2022-02-09 17:02:27",
        "updated_at": "2022-02-09 17:02:27",
        "tyre_brand": {
                     "id": 1,
                     "description": "Test  Dummy Update",
                     "code": "SAA",
                     "popular": 4,
                     "created_at": "2022-02-09 17:02:22",
                     "updated_at": "2022-02-09 17:02:07"
                }
   }
  }
],
"meta": {
    "pagination": {
        "total": 5,
        "count": 5,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/alerts?page=2",
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-designs

This endpoint will allow you to get the Tyre Designs in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“tyre_brands_id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
    • {“popular”: “asc”},
    • {“original_tyre_depth”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-designs/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "tyre_brands_id": "1",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1",
      "original_tyre_depth": "12.34"
    },
    {
      "ref_key": "tex",
      "tyre_brands_id": "2",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1",
      "original_tyre_depth": "12.34"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "tyre_brands_id": "1",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1",
      "original_tyre_depth": "12.34",
      "created_at": "2022-02-09T17:38:52.700962Z",
      "updated_at": "2022-02-09T17:38:52.700975Z"
    },
    {
      "tyre_brands_id": "2",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1",
      "original_tyre_depth": "12.34",
      "created_at": "2022-02-09T17:38:52.700983Z",
      "updated_at": "2022-02-09T17:38:52.700989Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-designs/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. tyre_brands_id (int, required) This is the column you want to store

  4. popular (int, nullable) This is the column you want to store

  5. original_tyre_depth (float, nullable) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-designs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 7,
    "description": "Dummy Text",
    "code": "SAAD",
    "original_tyre_depth": 12.34,
    "popular": 1,
    "deleted_at": "",
    "created_at": "2022-02-09 17:02:27",
    "updated_at": "2022-02-09 17:02:27",
    "tyre_brand": {
      "id": 1,
      "description": "Test  Dummy Update",
      "code": "SAA",
      "popular": 4,
      "created_at": "2022-02-09 17:02:22",
      "updated_at": "2022-02-09 17:02:07"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-designs/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-designs/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "7",
      "tyre_brands_id": "1",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1",
      "original_tyre_depth": "12.34"
    },
    {
      "ref_key": "tex",
      "id": "8",
      "tyre_brands_id": "2",
      "description": "Dummy Text",
      "code": "SAAD",
      "popular": "1",
      "original_tyre_depth": "12.34"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-designs/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to update

  3. tyre_brands_id (int, required) This is the column you want to update

  4. popular (int, nullable) This is the column you want to update

  5. original_tyre_depth (float, nullable) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-designs/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-designs/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) This is the column you want to update or store

  3. tyre_brands_id (int, required) This is the column you want to update or store

  4. popular (int, nullable) This is the column you want to update or store

  5. original_tyre_depth (float, nullable) This is the column you want to update or store

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-designs/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-designs/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-designs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-designs/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Failure Reason Category

Resources related to maintenance in the API.

Tyre Failure Reason Category is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-failure-reason-categories

This endpoint will allow you to get the Tyre Failure Reason Category in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-failure-reason-categories/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-failure-reason-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-failure-reason-categories/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-failure-reason-categories/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-failure-reason-categories/export

This endpoint will allow you to Export the Tyre Failure Reason Category information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-failure-reason-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-failure-reason-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Service Provider Mfd Categories

Resources related to maintenance in the API.

Service Provider Mfd Categories API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 3,
      "bcd_service_providers_id": 3,
      "bcd_service_provider": "Dummy Text",
      "dealer_categories_id": 1,
      "dealer_category": "CAT 1",
      "chamber_1_spaces": 25,
      "chamber_2_spaces": 0,
      "chamber_3_spaces": 0,
      "chamber_4_spaces": 0,
      "chamber_5_spaces": 0,
      "chamber_loads_per_day": 2,
      "date_from": "2017-03-01",
      "date_to": "2022-02-28",
      "should_submit": 1,
      "created_at": "2022-02-10 21:02:42",
      "updated_at": "2022-02-10 21:02:42",
      "deleted_at": ""
    },
    {
      "id": 4,
      "bcd_service_providers_id": 6,
      "bcd_service_provider": "Dummy Text",
      "dealer_categories_id": 1,
      "dealer_category": "CAT 2",
      "chamber_1_spaces": 25,
      "chamber_2_spaces": 0,
      "chamber_3_spaces": 0,
      "chamber_4_spaces": 0,
      "chamber_5_spaces": 0,
      "chamber_loads_per_day": 2,
      "date_from": "2017-03-01",
      "date_to": "2022-02-28",
      "should_submit": 1,
      "created_at": "2022-02-10 21:02:42",
      "updated_at": "2022-02-10 21:02:42",
      "deleted_at": ""
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "http://127.0.0.1:8000/api/bcd-service-provider-mfd-categories?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/bcd-service-provider-mfd-categories

This endpoint will allow you to get the Service Provider Mfd Categories in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_service_providers_id”: “asc”},
    • {“dealer_categories_id”: “asc”},
    • {“chamber_1_spaces”: “asc”},
    • {“chamber_2_spaces”: “asc”},
    • {“chamber_3_spaces”: “asc”},
    • {“chamber_4_spaces”: “asc”},
    • {“chamber_5_spaces”: “asc”},
    • {“chamber_loads_per_day”: “asc”},
    • {“date_from”: “asc”},
    • {“date_to”: “asc”},
    • {“should_submit”: “asc”}
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","bcd_service_providers_id":6,"dealer_categories_id":1,"chamber_1_spaces":25,"chamber_2_spaces":0,"chamber_3_spaces":0,"chamber_4_spaces":0,"chamber_5_spaces":0,"chamber_loads_per_day":2,"date_from":"2017-03-01","date_to":"2022-02-28","should_submit":1},
    {"ref_key":"223","bcd_service_providers_id":2,"dealer_categories_id":3,"chamber_1_spaces":25,"chamber_2_spaces":0,"chamber_3_spaces":0,"chamber_4_spaces":0,"chamber_5_spaces":0,"chamber_loads_per_day":2,"date_from":"2017-03-01","date_to":"2022-02-28","should_submit":1}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-service-provider-mfd-categories/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 3,
    "bcd_service_providers_id": 3,
    "bcd_service_provider": "DUMMY TEXT",
    "dealer_categories_id": 1,
    "dealer_category": "CAT 1",
    "chamber_1_spaces": 25,
    "chamber_2_spaces": 0,
    "chamber_3_spaces": 0,
    "chamber_4_spaces": 0,
    "chamber_5_spaces": 0,
    "chamber_loads_per_day": 2,
    "date_from": "2017-03-01",
    "date_to": "2022-02-28",
    "should_submit": 1,
    "created_at": "2022-02-10 21:02:42",
    "updated_at": "2022-02-10 21:02:42",
    "deleted_at": ""
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/bcd-service-provider-mfd-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","id":2,"bcd_service_providers_id":6,"dealer_categories_id":1,"chamber_1_spaces":25,"chamber_2_spaces":0,"chamber_3_spaces":0,"chamber_4_spaces":0,"chamber_5_spaces":0,"chamber_loads_per_day":2,"date_from":"2017-03-01","date_to":"2022-02-28","should_submit":1},
    {"ref_key":"111","bcd_service_providers_id":6,"dealer_categories_id":1,"chamber_1_spaces":25,"chamber_2_spaces":0,"chamber_3_spaces":0,"chamber_4_spaces":0,"chamber_5_spaces":0,"chamber_loads_per_day":2,"date_from":"2017-03-01","date_to":"2022-02-28","should_submit":1}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/bcd-service-provider-mfd-categories/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_service_providers_id (numeric, max:20, required) This is the Service Provider

  4. dealer_categories_id (numeric, max:20, required) This is the Dealer Category

  5. chamber_1_spaces (numeric, max:3, required) chamber 1 spaces

  6. chamber_2_spaces (numeric, max:3, optional) chamber 2 spaces

  7. chamber_3_spaces (numeric, max:3, optional) chamber 3 spaces

  8. chamber_4_spaces (numeric, max:3, optional) chamber 4 spaces

  9. chamber_5_spaces (numeric, max:3, optional) chamber 5 spaces

  10. chamber_loads_per_day (numeric, max:3, optional) chamber loads per day

  11. date_from (date, optional) Start Date

  12. date_to (date, optional) End Date

Import

POST https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/bcd-service-provider-mfd-categories/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/BcdServiceProviderMfdCategories-2022-02-10-21-58-06.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/bcd-service-provider-mfd-categories/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_service_providers_id”: “asc”},
    • {“dealer_categories_id”: “asc”},
    • {“chamber_1_spaces”: “asc”},
    • {“chamber_2_spaces”: “asc”},
    • {“chamber_3_spaces”: “asc”},
    • {“chamber_4_spaces”: “asc”},
    • {“chamber_5_spaces”: “asc”},
    • {“chamber_loads_per_day”: “asc”},
    • {“date_from”: “asc”},
    • {“date_to”: “asc”},
    • {“should_submit”: “asc”}
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/bcd-service-provider-mfd-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/bcd-service-provider-mfd-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Size Categories

Resources related to maintenance in the API.

Tyre Size Categories is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-size-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "16.5\"",
      "created_at": "2022-02-10 10:02:35",
      "updated_at": "2022-02-10 10:02:35",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-sizes-category?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-size-categories

This endpoint will allow you to get the Tyre Size Categories in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-size-categories
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"66"},
    {"ref_key":"222","description":"99"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-size-categories

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:10, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "description": "16.5\"",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-size-categories/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-size-categories
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"99"},
    {"ref_key":"test","id":"3","description":"66"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-size-categories

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:10, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-size-categories/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Depot-Types-2022-01-30-14-39-29.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-size-categories/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-size-categories/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-size-categories/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Sizes

Resources related to maintenance in the API.

Tyre Sizes is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-sizes
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 279,
      "tyre_constructions_id": 1,
      "tyre_constructions_title": "Radial",
      "truck_types_id": 1,
      "truck_types_title": "GIANT TRUCK",
      "tyre_size_categories_id": 11,
      "tyre_size_categories_title": "22.5\"",
      "code": null,
      "description": "12Rrrrr",
      "circumference_mm": 200,
      "min_tread_width": 0,
      "max_tread_width": 10.99,
      "casing_code": null,
      "casing_price_excl": 250,
      "popular": 0,
      "updated_at": "2022-02-11 10:02:13",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-sizes?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-sizes

This endpoint will allow you to get the Tyre Sizes in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
    • {“description”: “asc”},
    • {“circumference_mm”: “asc”},
    • {“min_tread_width”: “asc”},
    • {“max_tread_width”: “asc”},
    • {“casing_price_excl”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-sizes
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "tyre_constructions_id": 1,
        "truck_types_id": 1,
        "tyre_size_categories_id": 11,
        "code": "111",
        "description": "12Rrrrr",
        "circumference_mm": 200,
        "min_tread_width": 0,
        "max_tread_width": 10.99,
        "casing_code": "",
        "casing_price_excl": 250,
        "popular": 0
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-sizes

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. tyre_constructions_id (required) This is the column you want to update

    • must exist in table tyre_constructions

  3. truck_types_id (required) This is the column you want to update

    • must exist in table truck_types

  4. tyre_size_categories_id (required) This is the column you want to update

    • must exist in table tyre_size_categories

  5. code (string, max:15) This is the column you want to update

  6. description (string, max:25, required) This is the column you want to update

  7. circumference_mm (numeric, required) This is the column you want to update

  8. min_tread_width (numeric, required) This is the column you want to update

  9. max_tread_width (numeric, required) This is the column you want to update

  10. casing_price_excl (required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-sizes/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "description": "16.5\"",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-sizes/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-sizes
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "tyre_constructions_id": 1,
        "tyre_constructions_title": "Radial",
        "truck_types_id": 1,
        "truck_types_title": "GIANT TRUCK",
        "tyre_size_categories_id": 11,
        "tyre_size_categories_title": "22.5\"",
        "code": null,
        "description": "12Rrrdd",
        "circumference_mm": 200,
        "min_tread_width": 0,
        "max_tread_width": 10.99,
        "casing_code": null,
        "casing_price_excl": 250,
        "popular": 1
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-sizes

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. tyre_constructions_id (required) This is the column you want to update

    • must exist in table tyre_constructions

  4. truck_types_id (required) This is the column you want to update

    • must exist in table truck_types

  5. tyre_size_categories_id (required) This is the column you want to update

    • must exist in table tyre_size_categories

  6. code (string, max:15) This is the column you want to update

  7. description (string, max:25, required) This is the column you want to update

  8. circumference_mm (numeric, required) This is the column you want to update

  9. min_tread_width (numeric, required) This is the column you want to update

  10. max_tread_width (numeric, required) This is the column you want to update

  11. casing_price_excl (required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-sizes/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-sizes/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-sizes/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Tyre-Sizes-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-sizes/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-sizes/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-sizes/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Failure Reasons

Resources related to maintenance in the API.

Tyre Failure Reasons is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 2,
        "description": "Dummy Text",
        "code": "SAAD",
        "deleted_at": "",
        "created_at": "2022-02-09 17:02:27",
        "updated_at": "2022-02-09 17:02:27",
        "tyre_brand": {
                "id": 1,
                "description": "Test  Dummy Update",
                "created_at": "2022-02-09 17:02:22",
                "updated_at": "2022-02-09 17:02:07"
    }
},
    {
        "id": 4,
        "description": "Dummy Text",
        "code": "SAAD",
        "deleted_at": "",
        "created_at": "2022-02-09 17:02:27",
        "updated_at": "2022-02-09 17:02:27",
        "tyre_brand": {
                "id": 1,
                "description": "Test  Dummy Update",
                "code": "SAA",
                "created_at": "2022-02-09 17:02:22",
                "updated_at": "2022-02-09 17:02:07"
            }
        }
    },
    {
        "id": 5,
        "description": "Dummy Text",
        "code": "SAAD",
        "deleted_at": "",
        "created_at": "2022-02-09 17:02:27",
        "updated_at": "2022-02-09 17:02:27",
        "tyre_brand": {
                     "id": 1,
                     "description": "Test  Dummy Update",
                     "code": "SAA",
                     "created_at": "2022-02-09 17:02:22",
                     "updated_at": "2022-02-09 17:02:07"
                }
   }
  }
],
"meta": {
    "pagination": {
        "total": 5,
        "count": 5,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/alerts?page=2",
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-failure-reasons

This endpoint will allow you to get the Tyre Failure Reasons in the system

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“tyre_brands_id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
{
  "records": [
    {
      "ref_key": "abc",
      "tyre_failure_reason_categories_id": "2",
      "description": "Dummy Text",
      "code": "SAAD"
    },
    {
      "ref_key": "tex",
      "tyre_failure_reason_categories_id": "4",
      "description": "Dummy Text",
      "code": "SAAD"
    }
  ]
}
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "tyre_failure_reason_categories_id": "2",
      "description": "Dummy Text",
      "code": "SAAD",
      "created_at": "2022-02-11T10:38:13.456367Z",
      "updated_at": "2022-02-11T10:38:13.456380Z"
    },
    {
      "tyre_failure_reason_categories_id": "4",
      "description": "Dummy Text",
      "code": "SAAD",
      "created_at": "2022-02-11T10:38:13.456388Z",
      "updated_at": "2022-02-11T10:38:13.456395Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-failure-reasons/multiple

This endpoint will allow you to create records

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to store

  3. tyre_brands_id (int, required) This is the column you want to store

  4. popular (int, nullable) This is the column you want to store

  5. original_tyre_depth (float, nullable) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 7,
    "description": "Dummy Text",
    "code": "SAAD",
    "created_at": "2022-02-11 10:02:09",
    "updated_at": "2022-02-11 10:02:09",
    "deleted_at": "",
    "tyre_failure_reasons_category": {
      "id": 2,
      "description": "CASING RELATED",
      "created_at": "2022-02-09 19:02:27",
      "updated_at": "2022-02-09 19:02:27"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-failure-reasons/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
{
  "records": [
    {
      "ref_key": "abc",
      "id": "7",
      "tyre_failure_reason_categories_id": "4",
      "description": "Dummy Text",
      "code": "SAAD"
    },
    {
      "ref_key": "tex",
      "id": "8",
      "tyre_failure_reason_categories_id": "2",
      "description": "Dummy Text",
      "code": "SAAD"
    }
  ]
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-failure-reasons/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, required) This is the column you want to update

  3. code (string, required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-failure-reasons/import

This endpoint will allow you to Import records.

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created or if supplied and match with other ID record will be updated

  2. description (string, required) This is the column you want to update or store

  3. code (string, required) This is the column you want to update or store

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": 1,
  "email": "domain@example.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AncillaryProductCategory.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-failure-reasons/export

This endpoint will allow you to Export the ancillary-product-groups information to excel or PDF.

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date Optional for filtering

  2. end_date Optional for filtering

  3. Both has to be supplied for filtering

  4. If date filter supplied the end date must be a date after or equal to start date.

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-failure-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-failure-reasons/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Management System Types

Resources related to maintenance in the API.

Tyre Management System Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-management-system-types

This endpoint will allow you to get the Tyre Management System Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-management-system-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-management-system-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-management-system-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-management-system-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-management-system-types/export

This endpoint will allow you to Export the Tyre Management System Types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-management-system-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-management-system-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Management Systems

Resources related to maintenance in the API.

Tyre Management Systems is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-management-systems
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-management-systems?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-management-systems

This endpoint will allow you to get the Tyre Management Systems in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-management-systems/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-management-systems/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-management-systems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-management-systems/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-management-systems/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-management-systems/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-management-systems/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-management-systems/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-management-systems/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-management-systems/export

This endpoint will allow you to Export the Tyre Management Systems information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-management-systems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-management-systems/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Position Types

Resources related to maintenance in the API.

Tyre Position Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-position-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-position-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-position-types

This endpoint will allow you to get the Tyre Position Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-position-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-position-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-position-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-position-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-position-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-position-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-position-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-position-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-position-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-position-types/export

This endpoint will allow you to Export the Tyre Position Types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-position-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-position-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Positions

Resources related to maintenance in the API.

Tyre Positions is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-positions
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-positions?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-positions

This endpoint will allow you to get the Tyre Positions in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-positions/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-positions/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-positions/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-positions/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-positions/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-positions/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-positions/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-positions/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-positions/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-positions/export

This endpoint will allow you to Export the Tyre Positions information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-positions/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-positions/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Problems

Resources related to maintenance in the API.

Tyre Problems is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-problems
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-problems?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-problems

This endpoint will allow you to get the Tyre Problems in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-problems/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text"},
    {"ref_key":"222", "description": "Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-problems/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-problems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-problems/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-problems/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-problems/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-problems/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-problems/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-problems/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-problems/export

This endpoint will allow you to Export the Tyre Problems information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-problems/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-problems/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Types

Resources related to maintenance in the API.

Tyre Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "code": "1",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "code": "1",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/tyre-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-types

This endpoint will allow you to get the Tyre Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description": "Dummy Text", "code": "1"},
    {"ref_key":"222", "description": "Dummy Text", "code": "1"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

  3. code (int, max:1, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "code": "1",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key": "2222", "id": "2", "description": "Dummy Text", "code": "1"},
    {"ref_key": "test", "id": "3", "description": "Dummy Text", "code": "1"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

  4. code (int, max:1, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-Alert.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-types/export

This endpoint will allow you to Export the Tyre Types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“code”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Visit Frequencies

Resources related to maintenance in the API.

Visit Frequencies is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/visit-frequencies
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "BUS",
      "created_at": "2022-01-31 16:01:31",
      "updated_at": "2022-01-31 16:01:31",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/visit-frequencies

This endpoint will allow you to get the Visit Frequencies in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/visit-frequencies
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/visit-frequencies

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/visit-frequencies/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/visit-frequencies/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/visit-frequencies
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/visit-frequencies

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/visit-frequencies/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/visit-frequencies/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/visit-frequencies/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Visit-Frequencies-2022-02-14-10-21-15.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/visit-frequencies/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/visit-frequencies/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/visit-frequencies/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Pro-Tracker Test Results

Resources related to maintenance in the API.

Pro-Tracker Test Results is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "BUS",
      "created_at": "2022-01-31 16:01:31",
      "updated_at": "2022-01-31 16:01:31",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/pro-tracker-test-results

This endpoint will allow you to get the Pro-Tracker Test Results in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/pro-tracker-test-results

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:40, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/pro-tracker-test-results/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/pro-tracker-test-results

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:40, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/pro-tracker-test-results/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:40, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Pro-Tracker-Test-Results-2022-02-14-11-59-53.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/pro-tracker-test-results/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/pro-tracker-test-results/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/pro-tracker-test-results/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Pro Data Customers

Resources related to maintenance in the API.

Pro Data Customers is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customers
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 4868,
      "bcd_service_providers_id": 1,
      "area_of_opportunities_id": 1,
      "applications_id": 5,
      "customer_customer_code": "Description new",
      "ratings_id": null,
      "location_types_id": null,
      "customer_groups_id": null,
      "customer_sub_groups_id": null,
      "visit_frequencies_id": 7,
      "depot_types_id": 2,
      "contract_preferences_id": 3,
      "payment_terms_id": 2,
      "customer_super_groups_id": null,
      "depot_name": "JHB, DURBAN, PE, CT AND SATELITE GEORGE AND SALDANHA",
      "discard_reason": null,
      "eta_registration_number": null,
      "physical_address": "15 DORBYL ROAD\r\nSACKS CIRCLE\r\nBELLVILLE SOUTH",
      "physical_address_customer_code": "7530",
      "postal_address": "P O Box 3306\r\nTYGERPARK",
      "postal_address_customer_code": "7536",
      "total_ldv": "0",
      "total_4x2": "0",
      "total_6x4": "28",
      "total_tandem": "5",
      "total_tridem_d": "19",
      "total_tridem_ss": "0",
      "has_retreads": 1,
      "avg_km_per_year": 0,
      "monthly_fuel_budget": 0,
      "monthly_tyre_budget": null,
      "total_cost_per_km": 0,
      "current_tyre_supplier1": "TYREPOINT",
      "current_tyre_supplier2": null,
      "tyre_matching": 1,
      "total_retread_tyres": 0,
      "avg_scrap_per_month": 15,
      "pull_point_mm": 4,
      "avg_daily_tyre_changes": 0,
      "casing_value_virgin": 0,
      "casing_value_1_cap": 0,
      "pressure_variance": 9.99,
      "high_pressure_variance_perc": 0,
      "tyre_managment_system_types_id": null,
      "has_supervisor": 1,
      "supervisor_salary": 0,
      "has_fitters": 0,
      "fitter_salary": 0,
      "total_fitters": 0,
      "has_data_capturers": 0,
      "data_capturer_salary": 0,
      "has_service_fee": 1,
      "service_fee_amount": 0,
      "reports_needed": "STOCK ON HAND\r\nMONTHLY TYRE USE REPORT\r\nMANAGEMENT REPORTS",
      "other_major_problem": null,
      "other_required_program": null,
      "other_tyre_management_system": null,
      "other_success_factor": null,
      "other_required_dealer_capability": "0",
      "other_sales_approach": null,
      "max_tread_depth_diff_tolerance": 0,
      "proapp_sync_type": "turbo",
      "budini_tms_export_location": null,
      "total_new_tyres": 1,
      "updated_at": "2022-02-15 09:02:07",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/bcd-end-user-customers

This endpoint will allow you to get the Pro Data Customers in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“customer_customer_code”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customers
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencustomer_coded
Body
log_name: "Customers",
records:[
    {
        "ref_key":"2222",
        "bcd_service_providers_id": 1,
        "area_of_opportunities_id": 1,
        "applications_id": 5,
        "customer_code": "Description new",
        "ratings_id": null,
        "location_types_id": null,
        "customer_groups_id": null,
        "customer_sub_groups_id": null,
        "visit_frequencies_id": 7,
        "depot_types_id": 2,
        "contract_preferences_id": 3,
        "payment_terms_id": 2,
        "customer_super_groups_id": null,
        "depot_name": "JHB, DURBAN, PE, CT AND SATELITE GEORGE AND SALDANHA",
        "discard_reason": "",
        "eta_registration_number": "",
        "physical_address": "15 DORBYL ROAD\r\nSACKS CIRCLE\r\nBELLVILLE SOUTH\r\n",
        "physical_address_code": "7530",
        "postal_address": "P O Box 3306\r\nTYGERPARK",
        "postal_address_code": "7536",
        "total_ldv": "0",
        "total_4x2": "0",
        "total_6x4": "28",
        "total_tandem": "5",
        "total_tridem_d": "19",
        "total_tridem_ss": "0",
        "has_retreads": 1,
        "avg_km_per_year": 0,
        "monthly_fuel_budget": 0,
        "monthly_tyre_budget": 0,
        "total_cost_per_km": 0,
        "current_tyre_supplier1": "TYREPOINT ",
        "current_tyre_supplier2": "",
        "tyre_matching": 1,
        "total_retread_tyres": 0,
        "avg_scrap_per_month": 15,
        "pull_point_mm": 4,
        "avg_daily_tyre_changes": 0,
        "casing_value_virgin": 0,
        "casing_value_1_cap": 0,
        "pressure_variance": 9.99,
        "high_pressure_variance_perc": 0,
        "tyre_management_system_types_id": null,
        "has_supervisor": 1,
        "supervisor_salary": 0,
        "has_fitters": 0,
        "fitter_salary": 0,
        "total_fitters": 0,
        "has_data_capturers": 0,
        "data_capturer_salary": 0,
        "has_service_fee": 1,
        "service_fee_amount": 0,
        "reports_needed": "STOCK ON HAND\r\nMONTHLY TYRE USE REPORT\r\nMANAGEMENT REPORTS",
        "other_major_problem": "",
        "other_required_program": "",
        "other_tyre_management_system": "",
        "other_success_factor": "",
        "other_required_dealer_capability": 0,
        "other_sales_approach": "",
        "max_tread_depth_diff_tolerance": 0,
        "proapp_sync_type": "turbo",
        "budini_tms_export_location": "",
        "total_new_tyres": 1
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-end-user-customers

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencustomer_coded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_service_providers_id (required) This is the column you want to update

    • must exist in table bcd_service_providers

  3. area_of_opportunities_id (required) This is the column you want to update

    • must exist in table area_of_opportunities

  4. applications_id (required) This is the column you want to update

    • must exist in table applications

  5. customer_code (string, max:30) This is the column you want to update

  6. depot_name (string, max:200, optional) This is the column you want to update

  7. discard_reason (numeric, optaion) This is the column you want to update

  8. eta_registration_number (numeric, optional) This is the column you want to update

  9. physical_address (numeric, optional) This is the column you want to update

  10. physical_address_code (max: 5, optional) This is the column you want to update

    • … check more fields from the list call above

Show

GET https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
        "id": 6,
        "bcd_service_providers_id": 1,
        "area_of_opportunities_id": 1,
        "applications_id": 5,
        "customer_code": "Description new",
        "ratings_id": null,
        "location_types_id": null,
        "customer_groups_id": null,
        "customer_sub_groups_id": null,
        "visit_frequencies_id": 7,
        "depot_types_id": 2,
        "contract_preferences_id": 3,
        "payment_terms_id": 2,
        "customer_super_groups_id": null,
        "depot_name": "JHB, DURBAN, PE, CT AND SATELITE GEORGE AND SALDANHA",
        "discard_reason": "",
        "eta_registration_number": "",
        "physical_address": "15 DORBYL ROAD\r\nSACKS CIRCLE\r\nBELLVILLE SOUTH\r\n",
        "physical_address_code": "7530",
        "postal_address": "P O Box 3306\r\nTYGERPARK",
        "postal_address_code": "7536",
        "total_ldv": "0",
        "total_4x2": "0",
        "total_6x4": "28",
        "total_tandem": "5",
        "total_tridem_d": "19",
        "total_tridem_ss": "0",
        "has_retreads": 1,
        "avg_km_per_year": 0,
        "monthly_fuel_budget": 0,
        "monthly_tyre_budget": 0,
        "total_cost_per_km": 0,
        "current_tyre_supplier1": "TYREPOINT ",
        "current_tyre_supplier2": "",
        "tyre_matching": 1,
        "total_retread_tyres": 0,
        "avg_scrap_per_month": 15,
        "pull_point_mm": 4,
        "avg_daily_tyre_changes": 0,
        "casing_value_virgin": 0,
        "casing_value_1_cap": 0,
        "pressure_variance": 9.99,
        "high_pressure_variance_perc": 0,
        "tyre_management_system_types_id": null,
        "has_supervisor": 1,
        "supervisor_salary": 0,
        "has_fitters": 0,
        "fitter_salary": 0,
        "total_fitters": 0,
        "has_data_capturers": 0,
        "data_capturer_salary": 0,
        "has_service_fee": 1,
        "service_fee_amount": 0,
        "reports_needed": "STOCK ON HAND\r\nMONTHLY TYRE USE REPORT\r\nMANAGEMENT REPORTS",
        "other_major_problem": "",
        "other_required_program": "",
        "other_tyre_management_system": "",
        "other_success_factor": "",
        "other_required_dealer_capability": 0,
        "other_sales_approach": "",
        "max_tread_depth_diff_tolerance": 0,
        "proapp_sync_type": "turbo",
        "budini_tms_export_location": "",
        "total_new_tyres": 1
        "created_at": "2022-02-10 10:02:35",
        "updated_at": "2022-02-10 10:02:35",
        "deleted_at": null
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/bcd-end-user-customers/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customers
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencustomer_coded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_service_providers_id": 1,
        "area_of_opportunities_id": 1,
        "applications_id": 5,
        "customer_code": "Description new",
        "ratings_id": null,
        "location_types_id": null,
        "customer_groups_id": null,
        "customer_sub_groups_id": null,
        "visit_frequencies_id": 7,
        "depot_types_id": 2,
        "contract_preferences_id": 3,
        "payment_terms_id": 2,
        "customer_super_groups_id": null,
        "depot_name": "JHB, DURBAN, PE, CT AND SATELITE GEORGE AND SALDANHA",
        "discard_reason": "",
        "eta_registration_number": "",
        "physical_address": "15 DORBYL ROAD\r\nSACKS CIRCLE\r\nBELLVILLE SOUTH\r\n",
        "physical_address_code": "7530",
        "postal_address": "P O Box 3306\r\nTYGERPARK",
        "postal_address_code": "7536",
        "total_ldv": "0",
        "total_4x2": "0",
        "total_6x4": "28",
        "total_tandem": "5",
        "total_tridem_d": "19",
        "total_tridem_ss": "0",
        "has_retreads": 1,
        "avg_km_per_year": 0,
        "monthly_fuel_budget": 0,
        "monthly_tyre_budget": 0,
        "total_cost_per_km": 0,
        "current_tyre_supplier1": "TYREPOINT ",
        "current_tyre_supplier2": "",
        "tyre_matching": 1,
        "total_retread_tyres": 0,
        "avg_scrap_per_month": 15,
        "pull_point_mm": 4,
        "avg_daily_tyre_changes": 0,
        "casing_value_virgin": 0,
        "casing_value_1_cap": 0,
        "pressure_variance": 9.99,
        "high_pressure_variance_perc": 0,
        "tyre_management_system_types_id": null,
        "has_supervisor": 1,
        "supervisor_salary": 0,
        "has_fitters": 0,
        "fitter_salary": 0,
        "total_fitters": 0,
        "has_data_capturers": 0,
        "data_capturer_salary": 0,
        "has_service_fee": 1,
        "service_fee_amount": 0,
        "reports_needed": "STOCK ON HAND\r\nMONTHLY TYRE USE REPORT\r\nMANAGEMENT REPORTS",
        "other_major_problem": "",
        "other_required_program": "",
        "other_tyre_management_system": "",
        "other_success_factor": "",
        "other_required_dealer_capability": 0,
        "other_sales_approach": "",
        "max_tread_depth_diff_tolerance": 0,
        "proapp_sync_type": "turbo",
        "budini_tms_export_location": "",
        "total_new_tyres": 1
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/bcd-end-user-customers

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencustomer_coded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_service_providers_id (required) This is the column you want to update

    • must exist in table bcd_service_providers

  4. area_of_opportunities_id (required) This is the column you want to update

    • must exist in table area_of_opportunities

  5. applications_id (required) This is the column you want to update

    • must exist in table applications

  6. customer_code (string, max:30) This is the column you want to update

  7. depot_name (string, max:200, optional) This is the column you want to update

  8. discard_reason (numeric, optaion) This is the column you want to update

  9. eta_registration_number (numeric, optional) This is the column you want to update

  10. physical_address (numeric, optional) This is the column you want to update

  11. physical_address_code (max: 5, optional) This is the column you want to update

    • … check more fields from the list call above

Export

POST https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customers/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Pro-Data-Customer-2022-02-15-10-24-23.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/bcd-end-user-customers/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencustomer_coded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“depot_name”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customers/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/bcd-end-user-customers/{id}

This endpoint will allow you to delete a record

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

URI Parameters

  1. id (string, required) The record ID
GET https://laravel.bandag.zerobox.co.za/api/bcd-customer-tyre-problems-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 399,
      "bcd_end_user_customers_id": 636,
      "bcd_end_user_customers_code": "VZV-CT",
      "tyre_problems_id": 1,
      "tyre_problems_title": "Tread",
      "updated_at": "2022-02-18 08:02:39"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-customer-tyre-problems-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Tyre Problems",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_tyre_problems_ids":[],
        "add_tyre_problems_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-customer-tyre-problems-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_tyre_problems_ids (required) This is the column you want to update

    • must exist in table tyre_problems

  4. add_tyre_problems_ids (required) This is the column you want to update

    • must exist in table tyre_problems
GET https://laravel.bandag.zerobox.co.za/api/bcd-customer-tyre-problems-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 399,
    "bcd_end_user_customers_id": 636,
    "bcd_end_user_customers_code": "VZV-CT",
    "tyre_problems_id": 1,
    "tyre_problems_title": "Tread",
    "updated_at": "2022-02-18 08:02:39"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Customer-Tyre-Problems-Link-2022-02-18-10-37-10.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-customer-tyre-problems-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-required-programs-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 399,
      "bcd_end_user_customers_id": 636,
      "bcd_end_user_customers_code": "VZV-CT",
      "required_programs_id_id": 1,
      "required_programs_id_title": "Tread",
      "updated_at": "2022-02-18 08:02:39"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-required-programs-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Required Programs",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_required_programs_id_ids":[],
        "add_required_programs_id_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-required-programs-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_required_programs_id_ids (required) This is the column you want to update

    • must exist in table required_programs

  4. add_required_programs_id_ids (required) This is the column you want to update

    • must exist in table required_programs
GET https://laravel.bandag.zerobox.co.za/api/bcd-required-programs-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 399,
    "bcd_end_user_customers_id": 636,
    "bcd_end_user_customers_code": "VZV-CT",
    "required_programs_id_id": 1,
    "required_programs_id_title": "Tread",
    "updated_at": "2022-02-18 08:02:39"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Required-Programs-Link-2022-02-18-13-03-56.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-required-programs-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-reports-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "reports_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-reports-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-reports-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "reports_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-reports-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. reports_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-reports-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "reports_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-reports-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-reports-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. reports_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-reports-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-reports-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-reports-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“reports_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-reports-link/
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
  id: 3, 4
}
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-system-access-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "system_applications_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-system-access-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-system-access-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "system_applications_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-system-access-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. system_applications_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-system-access-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "system_applications_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-system-access-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_users_id": 1,
        "system_applications_id": "1",

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-system-access-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-system-access-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. system_applications_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-system-access-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-system-access-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-system-access-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“system_applications_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-system-access-link/
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-tyre-management-systems-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 22,
      "bcd_end_user_customers_id": 88,
      "bcd_end_user_customers_code": "LC-CT",
      "tyre_management_systems_id": 1,
      "tyre_management_systems_title": "None",
      "updated_at": "2022-02-18 20:02:55"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-tyre-management-systems-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Tyre Management Systems",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_tyre_management_systems_ids":[],
        "add_tyre_management_systems_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-tyre-management-systems-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_tyre_management_systems_ids (required) This is the column you want to update

    • must exist in table tyre_management_systems

  4. add_tyre_management_systems_ids (required) This is the column you want to update

    • must exist in table tyre_management_systems
GET https://laravel.bandag.zerobox.co.za/api/bcd-tyre-management-systems-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 22,
    "bcd_end_user_customers_id": 88,
    "bcd_end_user_customers_code": "LC-CT",
    "tyre_management_systems_id": 1,
    "tyre_management_systems_title": "None",
    "updated_at": "2022-02-18 20:02:55"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Tyre-Management-Systems-Link-2022-02-18-20-40-46.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-tyre-management-systems-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-success-factors-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 27,
      "bcd_end_user_customers_id": 95,
      "bcd_end_user_customers_code": "KT-CT",
      "success_factors_id": 4,
      "success_factors_title": "CPK",
      "updated_at": "2022-02-18 21:02:17"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-success-factors-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Success Factors",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_success_factors_ids":[],
        "add_success_factors_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-success-factors-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_success_factors_ids (required) This is the column you want to update

    • must exist in table success_factors

  4. add_success_factors_ids (required) This is the column you want to update

    • must exist in table success_factors
GET https://laravel.bandag.zerobox.co.za/api/bcd-success-factors-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 399,
    "bcd_end_user_customers_id": 636,
    "bcd_end_user_customers_code": "VZV-CT",
    "success_factors_id_id": 1,
    "success_factors_id_title": "Tread",
    "updated_at": "2022-02-18 08:02:39"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Success-Factors-Link-2022-02-18-21-59-39.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-success-factors-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-required-dealer-capabilities-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 35,
      "bcd_end_user_customers_id": 119,
      "bcd_end_user_customers_code": "CTX-ZIM",
      "required_dealer_capabilities_id": 5,
      "required_dealer_capabilities_title": "Warranty system",
      "updated_at": "2022-02-20 00:02:51"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-required-dealer-capabilities-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Required Dealer Capabilities",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_required_dealer_capabilities_ids":[],
        "add_required_dealer_capabilities_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-required-dealer-capabilities-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_required_dealer_capabilities_ids (required) This is the column you want to update

    • must exist in table required_dealer_capabilities

  4. add_required_dealer_capabilities_ids (required) This is the column you want to update

    • must exist in table required_dealer_capabilities
GET https://laravel.bandag.zerobox.co.za/api/bcd-required-dealer-capabilities-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 399,
    "bcd_end_user_customers_id": 636,
    "bcd_end_user_customers_code": "VZV-CT",
    "required_dealer_capabilities_id": 1,
    "required_dealer_capabilities_id_title": "Tread",
    "updated_at": "2022-02-18 08:02:39"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Required-Dealer-Capabilities-Link-2022-02-20-00-47-35.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-required-dealer-capabilities-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-sales-approaches-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 11,
      "bcd_end_user_customers_id": 95,
      "bcd_end_user_customers_code": "KT-CT",
      "sales_approaches_id": 2,
      "sales_approaches_title": "Relationship Selling",
      "updated_at": "2022-02-20 01:02:51"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-sales-approaches-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Sales Approach",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_sales_approaches_ids":[],
        "add_sales_approaches_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-sales-approaches-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_sales_approaches_ids (required) This is the column you want to update

    • must exist in table sales_approaches

  4. add_sales_approaches_ids (required) This is the column you want to update

    • must exist in table sales_approaches
GET https://laravel.bandag.zerobox.co.za/api/bcd-sales-approaches-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 399,
    "bcd_end_user_customers_id": 636,
    "bcd_end_user_customers_code": "VZV-CT",
    "sales_approaches_id_id": 1,
    "sales_approaches_id_title": "Tread",
    "updated_at": "2022-02-18 08:02:39"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Sales-Approaches-Link-2022-02-20-01-42-04.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-sales-approaches-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-market-segment-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1078,
      "bcd_end_user_customers_id": 691,
      "bcd_end_user_customers_code": "SBVS-CT",
      "market_segments_id": 11,
      "market_segments_title": "BUS",
      "updated_at": "2022-02-21 11:02:46"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-market-segment-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Market Segment",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "remove_market_segments_ids":[],
        "add_market_segments_ids": [2, 4, 3]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-market-segment-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_market_segments_ids (required) This is the column you want to update

    • must exist in table market_segments

  4. add_market_segments_ids (required) This is the column you want to update

    • must exist in table market_segments
GET https://laravel.bandag.zerobox.co.za/api/bcd-market-segment-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
    "id": 399,
    "bcd_end_user_customers_id": 636,
    "bcd_end_user_customers_code": "VZV-CT",
    "market_segments_id_id": 1,
    "market_segments_id_title": "Tread",
    "updated_at": "2022-02-18 08:02:39"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Market-Segment-Link-2022-02-21-11-29-47.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-market-segment-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-customer-services-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 5007,
      "bcd_end_user_customers_id": 9,
      "bcd_end_user_customers_code": "MO-CT",
      "required_services_id": 16,
      "required_services_title": "Pressure Checks",
      "service_frequencies_id": 1,
      "service_frequencies_title": "BI-MONTHLY",
      "used": 4,
      "needed": 1,
      "updated_at": "2022-02-21 21:02:13"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-customer-services-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 9,
        "customer_services":[
            {"required_services_id": 1, "service_frequencies_id": 1, "used": 1, "needed":1},
            {"required_services_id": 14, "service_frequencies_id": 2, "used": 1, "needed":1},
            {"required_services_id": 16, "service_frequencies_id": 4, "used": 1, "needed":1}
        ]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-customer-services-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. customer_services (array, required) array of services

    • required_services_id (required) This is the column you want to update
      • must exist in table required_services
    • service_frequencies_id (required) This is the column you want to update
      • must exist in table service_frequencies
    • used (optional) This is the column you want to update
    • needed (optional) This is the column you want to update
GET https://laravel.bandag.zerobox.co.za/api/bcd-customer-services-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
{
"success": true,
"data": {
        "id": 5009,
        "bcd_end_user_customers_id": 9,
        "bcd_end_user_customers_code": "MO-CT",
        "required_services_id": 1,
        "required_services_title": "On-site Personnel",
        "service_frequencies_id": 1,
        "service_frequencies_title": "BI-MONTHLY",
        "used": 1,
        "needed": 1,
        "updated_at": "2022-02-21 21:02:20"
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Customer-Services-Link-2022-02-21-21-38-09.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-customer-services-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "bcd_end_user_customers_id": 1,
      "tyre_positions_id": 3,
      "tyre_position_types_id": 2,
      "tyre_types_id": 1,
      "tyre_brands_id": null,
      "tyre_designs_id": null,
      "retread_brands_id": null,
      "retread_designs_id": null,
      "tyre_sizes_id": null,
      "price_paid": 0,
      "avg_performance_kms": 0,
      "updated_at": "2022-02-22 09:02:17"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Tyres Used",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 1,
        "tyre_positions_id": 1,
        "tyre_position_types_id": 1,
        "tyre_types_id": 2,
        "tyre_brands_id": 16,
        "tyre_designs_id": 118,
        "retread_brands_id": null,
        "retread_designs_id": null,
        "tyre_sizes_id": 28,
        "price_paid": 0,
        "avg_performance_kms": 0
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-tyres-used-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. tyre_positions_id (required) This is the column you want to update

    • must exist in table tyre_positions

  4. tyre_position_types_id (required) This is the column you want to update

    • must exist in table tyre_position_types

  5. tyre_types_id (optional) This is the column you want to update

    • must exist in table tyre_types

  6. tyre_brands_id (optional) This is the column you want to update

    • must exist in table tyre_brands

  7. tyre_designs_id (optional) This is the column you want to update

    • must exist in table tyre_designs

  8. retread_brands_id (optional) This is the column you want to update

    • must exist in table retread_brands

  9. retread_designs_id (optional) This is the column you want to update

    • must exist in table retread_designs

  10. tyre_sizes_id (optional) This is the column you want to update

    • must exist in table tyre_sizes

  11. price_paid (numeric) This is the column you want to update

  12. avg_performance_kms (numeric) This is the column you want to update

GET https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "description": "16.5\"",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_end_user_customers_id": 1,
        "tyre_positions_id": 1,
        "tyre_position_types_id": 1,
        "tyre_types_id": 2,
        "tyre_brands_id": 16,
        "tyre_designs_id": 118,
        "retread_brands_id": null,
        "retread_designs_id": null,
        "tyre_sizes_id": 28,
        "price_paid": 0,
        "avg_performance_kms": 0
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/bcd-tyres-used-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. tyre_positions_id (required) This is the column you want to update

    • must exist in table tyre_positions

  4. tyre_position_types_id (required) This is the column you want to update

    • must exist in table tyre_position_types

  5. tyre_types_id (optional) This is the column you want to update

    • must exist in table tyre_types

  6. tyre_brands_id (optional) This is the column you want to update

    • must exist in table tyre_brands

  7. tyre_designs_id (optional) This is the column you want to update

    • must exist in table tyre_designs

  8. retread_brands_id (optional) This is the column you want to update

    • must exist in table retread_brands

  9. retread_designs_id (optional) This is the column you want to update

    • must exist in table retread_designs

  10. tyre_sizes_id (optional) This is the column you want to update

    • must exist in table tyre_sizes

  11. price_paid (numeric) This is the column you want to update

  12. avg_performance_kms (numeric) This is the column you want to update

POST https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Bcd-Tyres-Used-Link-2022-02-22-11-11-38.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/bcd-tyres-used-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/bcd-tyres-used-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Bcd End User Customer Contacts

Resources related to maintenance in the API.

Bcd End User Customer Contacts is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "bcd_end_user_customers_id": 5,
      "bcd_end_user_customers_code": "SP-MG",
      "designations_id": 16,
      "designations_title": "FINANCIAL DIRECTOR/MANAGER",
      "contact_person": "MARK SEPTEMBER",
      "telephone": "27215507305",
      "email": "",
      "cell": "27825615465",
      "day": 0,
      "month": 0,
      "updated_at": "2022-02-22 14:02:36",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/bcd-end_user-customer-contacts

This endpoint will allow you to get the Bcd End User Customer Contacts in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”}
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 5,
        "bcd_end_user_customers_code": "SP-MG",
        "designations_id": 16,
        "designations_title": "FINANCIAL DIRECTOR/MANAGER",
        "contact_person": "Mbusi Lukhele",
        "telephone": "27215507305",
        "email": "ml@deta.co.za",
        "cell": "27825615465",
        "day": 0,
        "month": 0
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-end_user-customer-contacts

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. designations_id (required) This is the column you want to update

    • must exist in table designations

  4. contact_person (string, max:50) This is the column you want to update

  5. telephone (string, max:30, required) This is the column you want to update

  6. email (required, max:200) This is the column you want to update

  7. cell (max:20) This is the column you want to update

  8. fax (max:20) This is the column you want to update

  9. day (numeric: max:31) This is the column you want to update

  10. day (numeric: max:12) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "telephone": "16.5\"",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/bcd-end_user-customer-contacts/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 7048,
        "bcd_end_user_customers_id": 5,
        "bcd_end_user_customers_code": "SP-MG",
        "designations_id": 16,
        "designations_title": "FINANCIAL DIRECTOR/MANAGER",
        "contact_person": "Mbusi Tester",
        "telephone": "27215507305",
        "email": "ml@deta.co.za",
        "cell": "27825615465",
        "day": 0,
        "month": 0
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/bcd-end_user-customer-contacts

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  4. designations_id (required) This is the column you want to update

    • must exist in table designations

  5. contact_person (string, max:50) This is the column you want to update

  6. telephone (string, max:30, required) This is the column you want to update

  7. email (required, max:200) This is the column you want to update

  8. cell (max:20) This is the column you want to update

  9. fax (max:20) This is the column you want to update

  10. day (numeric: max:31) This is the column you want to update

  11. day (numeric: max:12) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/bcd-end_user-customer-contacts/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. designations_id (required) This is the column you want to update

    • must exist in table designations

  4. contact_person (string, max:50) This is the column you want to update

  5. telephone (string, max:30, required) This is the column you want to update

  6. email (required, max:200) This is the column you want to update

  7. cell (max:20) This is the column you want to update

  8. fax (max:20) This is the column you want to update

  9. day (numeric: max:31) This is the column you want to update

  10. day (numeric: max:12) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Tyre-Sizes-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/bcd-end_user-customer-contacts/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“telephone”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/bcd-end_user-customer-contacts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/bcd-end_user-customer-contacts/{id}

This endpoint will allow you to delete a record

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

URI Parameters

  1. id (string, required) The record ID
GET https://laravel.bandag.zerobox.co.za/api/prowheel-customer-access-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 279,
      "bcd_end_user_customers_id": 1,
      "bcd_end_user_customers_title": "Radial",
      "updated_at": "2022-02-11 10:02:13",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/prowheel-customer-access-link?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/prowheel-customer-access-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 1
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/prowheel-customer-access-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers
GET https://laravel.bandag.zerobox.co.za/api/prowheel-customer-access-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_end_user_customers_id": 1118,
    "bcd_end_user_customers_code": "BAL-CT",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/prowheel-customer-access-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Prowheel-Customer-Access-Link-2022-02-23-09-08-33.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/prowheel-customer-access-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/prowheel-customer-access-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Bcd End User Customer Notes

Resources related to maintenance in the API.

Bcd End User Customer Notes is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 15,
      "bcd_end_user_customers_id": 510,
      "bcd_end_user_customers_code": "MRM-CT",
      "bcd_users_id": 10,
      "bcd_users_title": "ROELO MARAIS",
      "note_types_id": 1,
      "date_captured": "2008-11-21 00:00:00",
      "reminder_date": "2008-11-25 00:00:00",
      "comments_task": "APPOINTMENT INITIAL VISIT",
      "responsible": "ROELO MARAIS",
      "date_competed": "2008-11-26 00:00:00",
      "updated_at": "2022-02-23 11:02:41",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/bcd-end-user-customer-notes

This endpoint will allow you to get the Bcd End User Customer Notes in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”}
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
log_name: "Notes",
records:[
    {
        "ref_key":"2222",
        "bcd_end_user_customers_id": 510,
        "bcd_end_user_customers_code": "MRM-CT",
        "bcd_users_id": 10,
        "bcd_users_title": "ROELO MARAIS",
        "note_types_id": 1,
        "date_captured": "2008-11-21 00:00:00",
        "reminder_date": "2008-11-25 00:00:00",
        "comments_task": "APPOINTMENT INITIAL VISIT",
        "responsible": "ROELO MARAIS",
        "date_competed": "2008-11-26 00:00:00"
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/bcd-end-user-customer-notes

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. bcd_users_id (required) This is the column you want to update

    • must exist in table users

  4. note_types_id (required) This is the column you want to update

    • must exist in table note_types

  5. date_captured (required, date format: Y-m-d H:i:s) This is the column you want to update

  6. reminder_date (required, date format: Y-m-d H:i:s) This is the column you want to update

  7. date_competed (required, date format: Y-m-d H:i:s) This is the column you want to update

  8. comments_task (required, max:255) This is the column you want to update

  9. responsible (required, max:50) This is the column you want to update

  10. max_tread_width (numeric, required) This is the column you want to update

  11. casing_price_excl (required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 15,
    "bcd_end_user_customers_id": 510,
    "bcd_users_id": 10,
    "note_types_id": 1,
    "reminder_date": "2008-11-25 00:00:00",
    "comments_task": "APPOINTMENT INITIAL VISIT",
    "responsible": "ROELO MARAIS",
    "date_competed": "2008-11-26 00:00:00",
    "updated_at": "2022-02-23 11:02:41",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/bcd-end-user-customer-notes/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 15,
        "bcd_end_user_customers_id": 510,
        "bcd_end_user_customers_code": "MRM-CT",
        "bcd_users_id": 10,
        "bcd_users_title": "ROELO MARAIS",
        "note_types_id": 1,
        "date_captured": "2008-11-21 00:00:00",
        "reminder_date": "2008-11-25 00:00:00",
        "comments_task": "APPOINTMENT INITIAL VISIT",
        "responsible": "ROELO MARAIS",
        "date_competed": "2008-11-26 00:00:00"
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/bcd-end-user-customer-notes

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  4. bcd_users_id (required) This is the column you want to update

    • must exist in table users

  5. note_types_id (required) This is the column you want to update

    • must exist in table note_types

  6. date_captured (required, date format: Y-m-d H:i:s) This is the column you want to update

  7. reminder_date (required, date format: Y-m-d H:i:s) This is the column you want to update

  8. date_competed (required, date format: Y-m-d H:i:s) This is the column you want to update

  9. comments_task (required, max:255) This is the column you want to update

  10. responsible (required, max:50) This is the column you want to update

  11. max_tread_width (numeric, required) This is the column you want to update

  12. casing_price_excl (required) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/bcd-end-user-customer-notes/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:10, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Tyre-Sizes-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/bcd-end-user-customer-notes/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”}
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/bcd-end-user-customer-notes/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/bcd-end-user-customer-notes/{id}

This endpoint will allow you to delete a record

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

URI Parameters

  1. id (string, required) The record ID

Data Sources

Resources related to maintenance in the API.

Data Sources is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/data-sources
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/data-sources

This endpoint will allow you to get the Data Sources in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/data-sources
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/data-sources

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/data-sources/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/data-sources/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/data-sources
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/data-sources

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/data-sources/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/data-sources/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/data-sources/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Data-Source-2022-02-23-14-29-33.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/data-sources/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/data-sources/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/data-sources/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Removal Reasons

Resources related to maintenance in the API.

Removal Reasons is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/removal-reasons
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/removal-reasons

This endpoint will allow you to get the Removal Reasons in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/removal-reasons
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/removal-reasons

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/removal-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/removal-reasons/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/removal-reasons
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/removal-reasons

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/removal-reasons/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/removal-reasons/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/removal-reasons/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Removal-Reason-2022-02-23-17-59-12.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/removal-reasons/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/removal-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/removal-reasons/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID
GET https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "area_of_opportunities_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "area_of_opportunities_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-area-of-opportunities-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. area_of_opportunities_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "area_of_opportunities_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_users_id": 1,
        "area_of_opportunities_id": "1",

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-area-of-opportunities-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. area_of_opportunities_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-area-of-opportunities-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-area-of-opportunities-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“area_of_opportunities_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-area-of-opportunities-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
      id: 3, 4
   }
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "retread_brands_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "retread_brands_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-proorder-retread-brands-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. retread_brands_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "retread_brands_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_users_id": 1,
        "retread_brands_id": "1",

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-proorder-retread-brands-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. retread_brands_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-proorder-retread-brands-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-proorder-retread-brands-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“retread_brands_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-proorder-retread-brands-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
      id: 3, 4
   }
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "orderform_consumable_types_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "orderform_consumable_types_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-proorder-consumable-type-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. orderform_consumable_types_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "orderform_consumable_types_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_users_id": 1,
        "orderform_consumable_types_id": "1",

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-proorder-consumable-type-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. orderform_consumable_types_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-proorder-consumable-type-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-proorder-consumable-type-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“orderform_consumable_types_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-proorder-consumable-type-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
      id: 3, 4
   }
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-service-provider-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "bcd_service_providers_id": "1",
        "auto_update_customer": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-service-provider-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-service-provider-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "bcd_service_providers_id": 1,
        "auto_update_customer": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-service-provider-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. bcd_service_providers_id (required) This is the column you want to store

  4. auto_update_customer (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-service-provider-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "bcd_service_providers_id": "1",
    "auto_update_customer": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-service-provider-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_users_id": 1,
        "bcd_service_providers_id": "1",
        "auto_update_customer": "1"

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-service-provider-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-service-provider-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. bcd_service_providers_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-service-provider-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-service-provider-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-service-provider-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“bcd_service_providers_id”: “asc”},
    • {“auto_update_customer”: “asc”}
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-service-provider-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
      id: 3, 4
   }
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-consumer-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "bcd_end_user_customers_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-consumer-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-consumer-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "bcd_end_user_customers_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-consumer-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. bcd_end_user_customers_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-consumer-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "bcd_end_user_customers_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-consumer-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-consumer-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. bcd_end_user_customers_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-consumer-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-consumer-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-consumer-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“bcd_end_user_customers_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-consumer-link/
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
  id: 3, 4
}
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "bcd_end_user_customers_id":"1",
        "can_import_turbo":"1",
        "can_export_prowheel":"1"
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "bcd_end_user_customers_id":"1",
        "can_import_turbo":"1",
        "can_export_prowheel":"1"
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-customer-prowheel-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. bcd_end_user_customers_id (required) This is the column you want to store

  4. can_import_turbo (required) This is the column you want to store

  5. can_export_prowheel (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
        "id": 6,
        "bcd_users_id": "1",
        "bcd_end_user_customers_id":"1",
        "can_import_turbo":"1",
        "can_export_prowheel":"1"
        "created_at": "2022-02-10 10:02:35",
        "updated_at": "2022-02-10 10:02:35",
        "deleted_at": null
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_end_user_customers_id":"1",
        "can_import_turbo":"1",
        "can_export_prowheel":"1"
        "auto_update_customer": "1"

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-customer-prowheel-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. bcd_end_user_customers_id (required) This is the column you want to store

  4. can_import_turbo (required) This is the column you want to store

  5. can_export_prowheel (required) This is the column you want to store

POST https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-customer-prowheel-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-customer-prowheel-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“bcd_end_user_customers_id”: “asc”},
    • {“can_import_turbo”: “asc”}
    • {“can_export_prowheel”: “asc”}
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-customer-prowheel-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
      id: 3, 4
   }
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "bcd_can_export_prostock":"1",
        "can_import_turbo":"1",
        "can_export_prostock":"1"
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "bcd_can_export_prostock":"1",
        "can_import_turbo":"1",
        "can_export_prostock":"1"
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-customer-prostock-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. bcd_can_export_prostock (required) This is the column you want to store

  4. can_import_turbo (required) This is the column you want to store

  5. can_export_prostock (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
        "id": 6,
        "bcd_users_id": "1",
        "bcd_can_export_prostock":"1",
        "can_import_turbo":"1",
        "can_export_prostock":"1"
        "created_at": "2022-02-10 10:02:35",
        "updated_at": "2022-02-10 10:02:35",
        "deleted_at": null
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
PATCH https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 280,
        "bcd_can_export_prostock":"1",
        "can_import_turbo":"1",
        "can_export_prostock":"1"
        "auto_update_customer": "1"

}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-customer-prostock-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. bcd_can_export_prostock (required) This is the column you want to store

  4. can_import_turbo (required) This is the column you want to store

  5. can_export_prostock (required) This is the column you want to store

POST https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-customer-prostock-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-customer-prostock-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“bcd_can_export_prostock”: “asc”},
    • {“can_import_turbo”: “asc”}
    • {“can_export_prostock”: “asc”}
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-customer-prostock-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
      id: 3, 4
   }
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "bcd_end_user_customers_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "bcd_end_user_customers_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-customer-profleet-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. bcd_end_user_customers_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "bcd_end_user_customers_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-customer-profleet-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. bcd_end_user_customers_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-customer-profleet-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-customer-profleet-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“bcd_end_user_customers_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-customer-profleet-link/
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
  id: 3, 4
}
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
GET https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 279,
        "bcd_users_id": 1,
        "bcd_service_providers_id": "1",
        "updated_at": "2022-02-11 10:02:13",
        "deleted_at": null
    }
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 500,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link?page=2"
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "bcd_users_id": 1,
        "bcd_service_providers_id": 1,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-service-provider-mfd-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to store

  3. bcd_service_providers_id (required) This is the column you want to store

GET https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 6,
    "bcd_users_id": "1",
    "bcd_service_providers_id": "1",
    "created_at": "2022-02-10 10:02:35",
    "updated_at": "2022-02-10 10:02:35",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/user-service-provider-mfd-link/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_users_id (int, required) required for new record or can be updated for existing record

  3. bcd_service_providers_id (int, required) required for new record or can be updated for existing record

POST https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/user-service-provider-mfd-link-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/user-service-provider-mfd-link/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“bcd_users_id”: “asc”},
    • {“bcd_service_providers_id”: “asc”},
  • ]
DELETE https://laravel.bandag.zerobox.co.za/api/user-service-provider-mfd-link/
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Body
{
  id: 3, 4
}
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Service Types

Resources related to maintenance in the API.

Service Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/service-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/service-types

This endpoint will allow you to get the Service Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/service-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/service-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/service-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/service-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/service-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/service-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/service-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/service-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/service-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Service-Types-2022-03-05-11-33-04.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/service-types/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/service-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/service-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Repair Types

Resources related to maintenance in the API.

Repair Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/repair-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/repair-types

This endpoint will allow you to get the Repair Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/repair-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/repair-types

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/repair-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/repair-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/repair-types
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/repair-types

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/repair-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/repair-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/repair-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Repair-Types-2022-03-07-11-33-19.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/repair-types/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/repair-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/repair-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Service Reasons

Resources related to maintenance in the API.

Service Reasons is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/service-reasons
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/service-reasons

This endpoint will allow you to get the Service Reasons in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/service-reasons
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/service-reasons

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/service-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/service-reasons/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/service-reasons
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/service-reasons

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/service-reasons/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/service-reasons/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/service-reasons/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Service-Reason-2022-03-07-13-13-22.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/service-reasons/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/service-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/service-reasons/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Actions

Resources related to maintenance in the API.

Tyre Actions is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-actions
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1,
      "description": "Cheaper Price",
      "created_at": "2022-02-03 09:02:33",
      "updated_at": "2022-02-03 09:02:33",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-actions

This endpoint will allow you to get the Tyre Actions in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-actions
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Description Aaaa"},
    {"ref_key":"222","description":"Description Bbbb"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-actions

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:30, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-actions/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 1,
    "description": "Cheaper Price",
    "created_at": "2022-02-03 09:02:33",
    "updated_at": "2022-02-03 09:02:33",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-actions/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-actions
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Description B"},
    {"ref_key":"test","id":"3","description":"Description Aaaa"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-actions

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:30, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-actions/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-actions/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:30, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-actions/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Tyre-Actions-2022-03-07-15-53-39.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-actions/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-actions/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-actions/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

SCC Price List & Standard Cost Preferred List

Resources related to maintenance in the API.

SCC Price List & Standard Cost Preferred List API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/preferred-standard-cost
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "tyre_sizes_id": 12,
      "tyre_size": "10.00-20",
      "retread_designs_id": 38,
      "retread_design": "LUG LOGGER",
      "tread_sizes_id": 8,
      "tread_size": "180.00",
      "item_code": null,
      "preferred_standard_cost": true,
      "preferred_price_list": false
    },
    {
      "tyre_sizes_id": 12,
      "tyre_size": "10.00-20",
      "retread_designs_id": 38,
      "retread_design": "LUG LOGGER",
      "tread_sizes_id": 9,
      "tread_size": "190.00",
      "item_code": null,
      "preferred_standard_cost": true,
      "preferred_price_list": false
    },
    {
      "tyre_sizes_id": 12,
      "tyre_size": "10.00-20",
      "retread_designs_id": 38,
      "retread_design": "LUG LOGGER",
      "tread_sizes_id": 1,
      "tread_size": "200.00",
      "item_code": null,
      "preferred_standard_cost": true,
      "preferred_price_list": false
    },
    {
      "tyre_sizes_id": 12,
      "tyre_size": "10.00-20",
      "retread_designs_id": 232,
      "retread_design": "PRO-RM3",
      "tread_sizes_id": 35,
      "tread_size": "205.00",
      "item_code": "35",
      "preferred_standard_cost": true,
      "preferred_price_list": true
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/preferred-standard-cost

This endpoint will allow you to get the SCC Price List & Standard Cost Preferred List in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. tyre_sizes_id is required

  3. They go under Params tab on postman

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“tyre_sizes_id”: “asc”},
    • {“retread_designs_id”: “asc”},
    • {“tread_sizes_id”: “asc”}
  • ]

Store

POST https://laravel.bandag.zerobox.co.za/api/preferred-standard-cost/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"ref2","tyre_sizes_id":12,"retread_designs_id":38,"tread_sizes_id":8,"item_code":null,"preferred_standard_cost":true,"preferred_price_list":false},
    {"ref_key":"ref3","tyre_sizes_id":12,"retread_designs_id":38,"tread_sizes_id":9,"item_code":null,"preferred_standard_cost":true,"preferred_price_list":false}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/preferred-standard-cost/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. tyre_sizes_id (numeric, max:20, required) This is the tyre_sizes_id

  3. retread_designs_id (numeric, max:20, required) This is the retread_designs_id

  4. tread_sizes_id (numeric, max:20, required) This is the tread_sizes_id

  5. item_code (numeric, max:20, required if preferred_price_list set to true||1) This is the item_code

  6. preferred_standard_cost (numeric, max:1, required)

  7. preferred_price_list (numeric, max:1, required)

Import

POST https://laravel.bandag.zerobox.co.za/api/preferred-standard-cost/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/preferred-standard-cost/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. Tyre Sizes ID (numeric, max:20, required) This is the tyre_sizes_id

  2. Retread Designs ID (numeric, max:20, required) This is the retread_designs_id

  3. Tread Sizes ID (numeric, max:20, required) This is the tread_sizes_id

  4. Item Code (numeric, max:20, required if preferred_price_list set to true||1) This is the item_code

  5. Preferred Standard Cost (numeric, max:1, required)

  6. Preferred Price List (numeric, max:1, required)

Export

POST https://laravel.bandag.zerobox.co.za/api/preferred-standard-cost/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/PreferredStandardCost-2022-02-28-20-22-24.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/preferred-standard-cost/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. tyre_sizes_id is required

  3. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“tyre_sizes_id”: “asc”},
    • {“retread_designs_id”: “asc”},
    • {“tread_sizes_id”: “asc”}
  • ]

Vehicle Types

Resources related to maintenance in the API.

Vehicle Types API eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0

List All

GET https://laravel.bandag.zerobox.co.za/api/vehicle-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "steer": 1,
      "drive": 0,
      "trailer": 1,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text 1",
      "steer": 1,
      "drive": 0,
      "trailer": 1,
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/vehicle-types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/vehicle-types

This endpoint will allow you to get the Vehicle Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-02-01} Optional for filtering

  2. end_date {2022-02-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/vehicle-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text", "steer": 1, "drive": 0, "trailer": 1},
    {"ref_key":"121","description":"Dummy Text", "steer": 0, "drive": 0, "trailer": 1}
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/vehicle-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/vehicle-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "steer": 1,
    "drive": 0,
    "trailer": 1,
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/vehicle-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/vehicle-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"121","id":"2","description":"Dummy Text", "steer": 0, "drive": 0, "trailer": 1},
    {"ref_key":"121","id":"1","description":"Dummy Text", "steer": 1, "drive": 1, "trailer": 1}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/vehicle-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/vehicle-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/vehicle-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/vehicle-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/Vehicle-Types-2022-03-01-03-15-05.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/vehicle-types/export

This endpoint will allow you to Export the applications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/vehicle-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/vehicle-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Vehicle Layouts

Resources related to maintenance in the API.

Vehicle Layouts is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/vehicle-layouts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 53,
      "vehicle_types_id": 2,
      "vehicle_type": "Trailer",
      "description": "Tridem Trailer - SS 1222",
      "total_tyre_positions": 6,
      "pic": "vehicle_layout_20120928092845_tridemtrailerss.jpg",
      "created_at": "2022-03-01 05:03:15",
      "updated_at": "2022-03-01 05:03:15",
      "deleted_at": ""
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/vehicle-layouts?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/vehicle-layouts

This endpoint will allow you to get the Vehicle Layouts in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. vehicle_types_id, description, total_tyre_positions Optional for filtering

  2. start_date {2022-01-01} Optional for filtering

  3. end_date {2022-01-31} Optional for filtering

  4. Both has to be supplied for filtering

  5. If only one is supplied filtering wont work

  6. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“vehicle_types_id”: “asc”},
    • {“description”: “asc”},
    • {“total_tyre_positions”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/vehicle-layouts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "vehicle_types_id": 2,
        "vehicle_type": "Trailer",
        "description": "Tridem Trailer - SS 1222",
        "total_tyre_positions": 6,
        "pic": "vehicle_layout_20120928092845_tridemtrailerss.jpg"
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/vehicle-layouts

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. vehicle_types_id (required) This is the column you want to update

    • must exist in table vehicle_types

  3. description (max:255) This is the description column you want to update

  4. total_tyre_positions (numeric: max:11) This is the total_tyre_positions column you want to update

  5. pic (max:255) This is the pic column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/vehicle-layouts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": {
        "id": 6,
        "vehicle_types_id": 2,
        "vehicle_type": "Trailer",
        "description": "Tridem Trailer - SS 1222",
        "total_tyre_positions": 6,
        "pic": "vehicle_layout_20120928092845_tridemtrailerss.jpg"
        "created_at": "2022-02-10 10:02:35",
        "updated_at": "2022-02-10 10:02:35",
        "deleted_at": null
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/vehicle-layouts/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/vehicle-layouts
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 7048,
        "vehicle_types_id": 2,
        "vehicle_type": "Trailer",
        "description": "Tridem Trailer - SS 1222",
        "total_tyre_positions": 6,
        "pic": "vehicle_layout_20120928092845_tridemtrailerss.jpg"
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/vehicle-layouts

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. vehicle_types_id (required) This is the column you want to update

    • must exist in table vehicle_types

  4. description (max:255) This is the description column you want to update

  5. total_tyre_positions (numeric: max:11) This is the total_tyre_positions column you want to update

  6. pic (max:255) This is the pic column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/vehicle-layouts/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/vehicle-layouts/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. vehicle_types_id (required) This is the column you want to update

    • must exist in table vehicle_types

  3. description (max:255) This is the description column you want to update

  4. total_tyre_positions (numeric: max:11) This is the total_tyre_positions column you want to update

  5. pic (max:255) This is the pic column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/vehicle-layouts/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/VehicleLayouts-2022-03-01-05-16-43.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/vehicle-layouts/export

This endpoint will allow you to Export the designations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“vehicle_types_id”: “asc”},
    • {“total_tyre_positions”: “asc”}
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/vehicle-layouts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/vehicle-layouts/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Acquisition Methods

Resources related to maintenance in the API.

Acquisition Methods is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/acquisition-methods
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/Acquisition Methods?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/acquisition-methods

This endpoint will allow you to get the Acquisition Methods in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/acquisition-methods/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/acquisition-methods/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/acquisition-methods/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/acquisition-methods/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/acquisition-methods/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/acquisition-methods/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/acquisition-methods/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/acquisition-methods/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/acquisition-methods/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/acquisition-methods/export

This endpoint will allow you to Export the Acquisition Methods information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/acquisition-methods/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/acquisition-methods/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Acquisition Types

Resources related to maintenance in the API.

Acquisition Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/acquisition-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/Acquisition Types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/acquisition-types

This endpoint will allow you to get the Acquisition Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/acquisition-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/acquisition-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/acquisition-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/acquisition-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/acquisition-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/acquisition-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/acquisition-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/acquisition-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/acquisition-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/acquisition-types/export

This endpoint will allow you to Export the Acquisition Types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/acquisition-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/acquisition-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Tyre Locations

Resources related to maintenance in the API.

Tyre Locations is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/tyre-locations
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/Tyre Locations?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/tyre-locations

This endpoint will allow you to get the Tyre Locations in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/tyre-locations/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/tyre-locations/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/tyre-locations/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/tyre-locations/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/tyre-locations/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/tyre-locations/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/tyre-locations/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/tyre-locations/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/tyre-locations/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/tyre-locations/export

This endpoint will allow you to Export the Tyre Locations information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/tyre-locations/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/tyre-locations/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

ETA Callout Types

Resources related to maintenance in the API.

ETA Callout Types is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/eta-callout-types
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ETA Callout Types?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/eta-callout-types

This endpoint will allow you to get the ETA Callout Types in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/eta-callout-types/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/eta-callout-types/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/eta-callout-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/eta-callout-types/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/eta-callout-types/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/eta-callout-types/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/eta-callout-types/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/eta-callout-types/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/eta-callout-types/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/eta-callout-types/export

This endpoint will allow you to Export the ETA Callout Types information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/eta-callout-types/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/eta-callout-types/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

ETA Products

Resources related to maintenance in the API.

ETA Products is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/eta-products
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ETA Products?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/eta-products

This endpoint will allow you to get the ETA Products in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/eta-products/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/eta-products/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/eta-products/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/eta-products/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/eta-products/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/eta-products/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/eta-products/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/eta-products/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/eta-products/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/eta-products/export

This endpoint will allow you to Export the ETA Products information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/eta-products/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/eta-products/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

ETA Removal Reasons

Resources related to maintenance in the API.

ETA Removal Reasons is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ETA Removal Reasons?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/eta-removal-reasons

This endpoint will allow you to get the ETA Removal Reasons in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111","description":"Dummy Text"},
    {"ref_key":"222","description":"Dummy Text"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/eta-removal-reasons/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 5,
    "description": "Dummy Text",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/eta-removal-reasons/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text"},
    {"ref_key":"test","id":"3","description":"Dummy Text"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/eta-removal-reasons/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:20, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/eta-removal-reasons/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/eta-removal-reasons/export

This endpoint will allow you to Export the ETA Removal Reasons information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/eta-removal-reasons/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/eta-removal-reasons/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

ETA Notifications

Resources related to maintenance in the API.

ETA Notifications is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/eta-notifications
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "email": "example@domain.co.za",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "email": "example@domain.co.za",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/EtaNotifications?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/eta-notifications

This endpoint will allow you to get the ETA Notifications in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“email”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/eta-notifications/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description":"Dummy Text", "email":"email@domain.co.za"},
    {"ref_key":"222", "description":"Dummy Text", "email":"email@domain.co.za"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/eta-notifications/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/eta-notifications/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
    "data": {
        "id": 5,
        "description": "Dummy Text",
        "email": "email@domain.co.za"
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/eta-notifications/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/eta-notifications/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text", "email":"email@domain.co.za"},
    {"ref_key":"test","id":"3","description":"Dummy Text", "email":"email@domain.co.za"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/eta-notifications/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:50, optional) This is the column you want to update

  4. email (string, max:50, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/eta-notifications/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/eta-notifications/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:40, optional) required for new record

  3. email (string, max:50, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/eta-notifications/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/eta-notifications/export

This endpoint will allow you to Export the ETA Notifications information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“email”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/eta-notifications/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/eta-notifications/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

ProTracker Alerts

Resources related to maintenance in the API.

ProTracker Alerts is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 6,
      "description": "Dummy Text",
      "email": "example@domain.co.za",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 20:01:36",
      "deleted_at": "2022-01-20 20:01:36"
    },
    {
      "id": 7,
      "description": "Dummy Text",
      "email": "example@domain.co.za",
      "created_at": "2022-01-20 18:01:01",
      "updated_at": "2022-01-20 18:01:01",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 8,
      "count": 8,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1,
      "prev_page_url": null,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/ProTracker Alerts?page=2"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/pro-tracker-alerts

This endpoint will allow you to get the ProTracker Alerts in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“email”: “asc”},
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"111", "description":"Dummy Text", "email":"email@domain.co.za"},
    {"ref_key":"222", "description":"Dummy Text", "email":"email@domain.co.za"},
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/pro-tracker-alerts/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. description (string, max:20, required) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
    "data": {
        "id": 5,
        "description": "Dummy Text",
        "email": "email@domain.co.za"
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",
        "deleted_at": null
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/pro-tracker-alerts/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {"ref_key":"2222","id":"2","description":"Dummy Text", "email":"email@domain.co.za"},
    {"ref_key":"test","id":"3","description":"Dummy Text", "email":"email@domain.co.za"}
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/pro-tracker-alerts/multiple

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. description (string, max:50, optional) This is the column you want to update

  4. email (string, max:50, optional) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/pro-tracker-alerts/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. description (string, max:20, optional) required for new record

  3. email (string, max:20, optional) required for new record

Export

POST https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-AcquisitionMethods.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/pro-tracker-alerts/export

This endpoint will allow you to Export the ProTracker Alerts information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
    • {“email”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/pro-tracker-alerts/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/pro-tracker-alerts/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID
GET https://laravel.bandag.zerobox.co.za/api/user-customer-access-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 35426,
      "bcd_end_user_customers_id": 208,
      "bcd_end_user_customers_code": "BID-CT",
      "bcd_users_id": 48,
      "bcd_users_title": "PETER FARMERY",
      "updated_at": "2022-05-13 10:05:50"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "http://127.0.0.1:8000/api/user-customer-access-link?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/user-customer-access-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "id": 35426,
        "bcd_end_user_customers_id": 208,
        "bcd_users_id": 48,
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-customer-access-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_users_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. remove_bcd_end_user_customers_ids (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  4. add_bcd_end_user_customers_ids (required) This is the column you want to update

    • must exist in table bcd_end_user_customers
GET https://laravel.bandag.zerobox.co.za/api/user-customer-access-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 35426,
    "bcd_end_user_customers_id": 208,
    "bcd_end_user_customers_code": "BID-CT",
    "bcd_users_id": 48,
    "bcd_users_title": "PETER FARMERY",
    "updated_at": "2022-05-13 10:05:50"
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/User-Customer-Access-Link-2022-02-18-21-59-39.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/user-customer-access-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Activity Logs

Resources related to maintenance in the API.

Activity Logs is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/activity-logs
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 9,
        "log_name": "default",
        "description": "deleted",
        "subject_type": "App\Modules\BcdEndUserCustomerContacts\Models\BcdEndUserCustomerContact",
        "subject_id": 6997,
        "causer_type": "App\Models\User",
        "causer_name": "Rustum Tavaria",
        "causer_id": 3,
        "properties": "{\"attributes\":{\"id\":6997,\"bcd_end_user_customers_id\":2973,\"designations_id\":7,\"contact_person\":\"www\",\"telephone\":null,\"email\":\"ml@deta.co.za\",\"cell\":\"223331\",\"fax\":\"222333\",\"day\":1,\"month\":2,\"created_at\":\"2022-05-12T13:34:41.000000Z\",\"updated_at\":\"2022-05-12T19:00:13.000000Z\",\"deleted_at\":\"2022-05-12T19:00:13.000000Z\"}}",
        "created_at": "2022-05-12 19:05:13",
        "updated_at": "2022-05-12 19:05:13"
    },
    {
        "id": 10,
        "log_name": "default",
        "description": "deleted",
        "subject_type": "App\Modules\BcdEndUserCustomerContacts\Models\BcdEndUserCustomerContact",
        "subject_id": 6998,
        "causer_type": "App\Models\User",
        "causer_name": "Rustum Tavaria",
        "causer_id": 3,
        "properties": "{\"attributes\":{\"id\":6998,\"bcd_end_user_customers_id\":2973,\"designations_id\":5,\"contact_person\":\"eeee\",\"telephone\":null,\"email\":null,\"cell\":\"3333\",\"fax\":null,\"day\":2,\"month\":2,\"created_at\":\"2022-05-12T18:15:51.000000Z\",\"updated_at\":\"2022-05-12T19:00:13.000000Z\",\"deleted_at\":\"2022-05-12T19:00:13.000000Z\"}}",
        "created_at": "2022-05-12 19:05:13",
        "updated_at": "2022-05-12 19:05:13"
    },
    {
        "id": 11,
        "log_name": "default",
        "description": "deleted",
        "subject_type": "App\Modules\BcdEndUserCustomerContacts\Models\BcdEndUserCustomerContact",
        "subject_id": 6999,
        "causer_type": "App\Models\User",
        "causer_name": "Rustum Tavaria",
        "causer_id": 3,
        "properties": "{\"attributes\":{\"id\":6999,\"bcd_end_user_customers_id\":2973,\"designations_id\":10,\"contact_person\":\"xxx\",\"telephone\":null,\"email\":null,\"cell\":\"222\",\"fax\":null,\"day\":2,\"month\":3,\"created_at\":\"2022-05-12T19:00:41.000000Z\",\"updated_at\":\"2022-05-12T19:22:43.000000Z\",\"deleted_at\":\"2022-05-12T19:22:43.000000Z\"}}",
        "created_at": "2022-05-12 19:05:43",
        "updated_at": "2022-05-12 19:05:43"
    },
    {
        "id": 12,
        "log_name": "default",
        "description": "deleted",
        "subject_type": "App\Modules\BcdEndUserCustomerContacts\Models\BcdEndUserCustomerContact",
        "subject_id": 7000,
        "causer_type": "App\Models\User",
        "causer_name": "Rustum Tavaria",
        "causer_id": 3,
        "properties": "{\"attributes\":{\"id\":7000,\"bcd_end_user_customers_id\":2973,\"designations_id\":3,\"contact_person\":\"wwww\",\"telephone\":null,\"email\":null,\"cell\":\"22111\",\"fax\":null,\"day\":null,\"month\":null,\"created_at\":\"2022-05-12T19:09:33.000000Z\",\"updated_at\":\"2022-05-12T19:22:43.000000Z\",\"deleted_at\":\"2022-05-12T19:22:43.000000Z\"}}",
        "created_at": "2022-05-12 19:05:43",
        "updated_at": "2022-05-12 19:05:43"
    }
],
"meta": {
    "pagination": {
        "total": 4,
        "count": 4,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "next_page_url": null,
        "prev_page_url": null
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/activity-logs

This endpoint will allow you to get the Activity Logs in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“log_name”: “asc”},
    • {“description”: “asc”},
    • {“subject_type”: “asc”},
    • {“subject_id”: “asc”},
    • {“causer_type”: “asc”},
    • {“causer_id”: “asc”}
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Show

GET https://laravel.bandag.zerobox.co.za/api/activity-logs/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 9,
    "log_name": "default",
    "description": "deleted",
    "subject_type": "App\\Modules\\BcdEndUserCustomerContacts\\Models\\BcdEndUserCustomerContact",
    "subject_id": 6997,
    "causer_type": "App\\Models\\User",
    "causer_name": "Rustum Tavaria",
    "causer_id": 3,
    "properties": "{\"attributes\":{\"id\":6997,\"bcd_end_user_customers_id\":2973,\"designations_id\":7,\"contact_person\":\"www\",\"telephone\":null,\"email\":\"ml@deta.co.za\",\"cell\":\"223331\",\"fax\":\"222333\",\"day\":1,\"month\":2,\"created_at\":\"2022-05-12T13:34:41.000000Z\",\"updated_at\":\"2022-05-12T19:00:13.000000Z\",\"deleted_at\":\"2022-05-12T19:00:13.000000Z\"}}",
    "created_at": "2022-05-12 19:05:13",
    "updated_at": "2022-05-12 19:05:13"
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/activity-logs/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Export

POST https://laravel.bandag.zerobox.co.za/api/activity-logs/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/ActivityLogs-2022-05-12-20-54-20.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/activity-logs/export

This endpoint will allow you to Export the Activity Logs information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“log_name”: “asc”},
    • {“description”: “asc”},
    • {“subject_type”: “asc”},
    • {“subject_id”: “asc”},
    • {“causer_type”: “asc”},
    • {“causer_id”: “asc”}
  • ]

Graphs

Resources related to maintenance in the API.

Graphs is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/graphs/library-files
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "js_libraries": "ICAgICAgICA8IS0tLSBjYW52YXMganMgLS0tLS0tLT4KICAgICAgICA8c2NyaXB0IHNyYz0iaHR0cDovLzEyNy4wLjAuMTo4MDAwL3BsdWdpbnMvY2FudmFzanMvY2FudmFzanMubWluLmpzIj48L3NjcmlwdD4KICAgICAgICA8c2NyaXB0IHNyYz0iaHR0cDovLzEyNy4wLjAuMTo4MDAwL3BsdWdpbnMvY2FudmFzanMvY2FudmFzanMuZm9udC5zZXR0aW5ncy5qcyI+PC9zY3JpcHQ+CiAgICAgICAg",
    "css_libraries": "ICAgICAgICA8IS0tLSBjYW52YXMgY3NzIC0tLS0tLS0+CiAgICAgICAgPGxpbmsgaHJlZj0iaHR0cHM6Ly9mb250cy5nb29nbGVhcGlzLmNvbS9jc3M/ZmFtaWx5PU1vbnRzZXJyYXQiIHJlbD0ic3R5bGVzaGVldCI+CiAgICAgICAg"
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/graphs/library-files

This endpoint will allow you to get the Graphs library files

Returned values

  1. js_libraries This value is base64 encoded

  2. css_libraries This value is base64 encoded

Show

POST https://laravel.bandag.zerobox.co.za/api/graphs/canvas-js-pie
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "graph_id": "marketsharegraphssss",
  "graph_title": "RETREAD MARKET SHARE",
  "data": [
    {
      "y": 43,
      "legendText": "BANDAG",
      "label": "BANDAG"
    },
    {
      "y": 29,
      "legendText": "NOT SELECTED",
      "label": "NOT SELECTED"
    },
    {
      "y": 15,
      "legendText": "BRIDGESTONE PCT",
      "label": "BRIDGESTONE PCT"
    }
  ]
}
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "ICAgICAgICA8c2NyaXB0IHR5cGU9InRleHQvamF2YXNjcmlwdCI+CiAgICAgICAgd2luZG93Lm9ubG9hZCA9IGZ1bmN0aW9uICgpIHsKICAgICAgICAgICAgdmFyIGNoYXJ0ID0gbmV3IENhbnZhc0pTLkNoYXJ0KCdtYXJrZXRzaGFyZWdyYXBoc3NzcycsIHsKICAgICAgICAgICAgICAgIGNvbG9yU2V0OiAiYmFuZGFnU2hhZGVzIiwKICAgICAgICAgICAgICAgIHRpdGxlOnsKICAgICAgICAgICAgICAgICAgICB0ZXh0OiAnUkVUUkVBRCBNQVJLRVQgU0hBUkUnLAogICAgICAgICAgICAgICAgICAgIGZvbnRTaXplOiB0aXRsZV9mb250U2l6ZSwKICAgICAgICAgICAgICAgICAgICBmb250RmFtaWx5OiB0aXRsZV9mb250RmFtaWx5LAogICAgICAgICAgICAgICAgICAgIGZvbnRXZWlnaHQ6IHRpdGxlX2ZvbnRXZWlnaHQsCiAgICAgICAgICAgICAgICAgICAgZm9udENvbG9yOiAgdGl0bGVfZm9udENvbG9yCiAgICAgICAgICAgICAgICB9LAogICAgICAgICAgICAgICAgYXhpc1g6IHsKICAgICAgICAgICAgICAgICAgICBsYWJlbEZvbnRTaXplOiBheGlzWF9mb250U2l6ZSwKICAgICAgICAgICAgICAgICAgICBsYWJlbEZvbnRGYW1pbHk6IGF4aXNYX2ZvbnRGYW1pbHksCiAgICAgICAgICAgICAgICAgICAgbGFiZWxGb250V2VpZ2h0OiBheGlzWF9mb250V2VpZ2h0LAogICAgICAgICAgICAgICAgICAgIGxhYmVsRm9udENvbG9yOiAgYXhpc1hfZm9udENvbG9yCiAgICAgICAgICAgICAgICB9LAogICAgICAgICAgICAgICAgYXhpc1k6IHsKICAgICAgICAgICAgICAgICAgICBsYWJlbEZvbnRTaXplOiBheGlzWV9mb250U2l6ZSwKICAgICAgICAgICAgICAgICAgICBsYWJlbEZvbnRGYW1pbHk6IGF4aXNZX2ZvbnRGYW1pbHksCiAgICAgICAgICAgICAgICAgICAgbGFiZWxGb250V2VpZ2h0OiBheGlzWV9mb250V2VpZ2h0LAogICAgICAgICAgICAgICAgICAgIGxhYmVsRm9udENvbG9yOiAgYXhpc1lfZm9udENvbG9yCiAgICAgICAgICAgICAgICB9LAogICAgICAgICAgICAgICAgdGhlbWU6IGNhbnZhc2pzX3RoZW1lLAogICAgICAgICAgICAgICAgZXhwb3J0RW5hYmxlZDogY2FudmFzanNfZXhwb3J0RW5hYmxlZCwKICAgICAgICAgICAgICAgIGFuaW1hdGlvbkVuYWJsZWQ6IGNhbnZhc2pzX2FuaW1hdGlvbkVuYWJsZWQsCiAgICAgICAgICAgICAgICBhbmltYXRpb25EdXJhdGlvbjogY2FudmFzanNfYW5pbWF0aW9uRHVyYXRpb24sCiAgICAgICAgICAgICAgICB6b29tRW5hYmxlZDpjYW52YXNqc196b29tRW5hYmxlZCwKICAgICAgICAgICAgICAgIGludGVyYWN0aXZpdHlFbmFibGVkOiBjYW52YXNqc19pbnRlcmFjdGl2aXR5RW5hYmxlZCwKICAgICAgICAgICAgICAgIC8vd2lkdGg6IDcwMCwKICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgZGF0YTogWyAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAgICAgdHlwZTogInBpZSIsLy8gQ2hhbmdlIHR5cGUgdG8gImRvdWdobnV0IiwgImxpbmUiLCAic3BsaW5lQXJlYSIsIGV0Yy4KICAgICAgICAgICAgICAgICAgICBpbmRleExhYmVsRm9udFNpemU6IGRhdGFfaW5kZXhMYWJlbEZvbnRTaXplLAogICAgICAgICAgICAgICAgICAgIGluZGV4TGFiZWxGb250RmFtaWx5OiBkYXRhX2luZGV4TGFiZWxGb250RmFtaWx5LAogICAgICAgICAgICAgICAgICAgIGluZGV4TGFiZWxGb250V2VpZ2h0OiBkYXRhX2luZGV4TGFiZWxGb250V2VpZ2h0LAogICAgICAgICAgICAgICAgICAgIGluZGV4TGFiZWxGb250Q29sb3I6IGRhdGFfaW5kZXhMYWJlbEZvbnRDb2xvciwKICAgICAgICAgICAgICAgICAgICBzaG93SW5MZWdlbmQ6IGRhdGFfc2hvd0luTGVnZW5kLAogICAgICAgICAgICAgICAgICAgIHRvb2xUaXBDb250ZW50OiAie3l9ICUiLAogICAgICAgICAgICAgICAgICAgIGxlZ2VuZFRleHQ6ICJ7aW5kZXhMYWJlbH0iLAogICAgICAgICAgICAgICAgICAgIGRhdGFQb2ludHM6IFt7InkiOjQzLCJsZWdlbmRUZXh0IjoiQkFOREFHIiwibGFiZWwiOiJCQU5EQUcifSx7InkiOjI5LCJsZWdlbmRUZXh0IjoiTk9UIFNFTEVDVEVEIiwibGFiZWwiOiJOT1QgU0VMRUNURUQifSx7InkiOjE1LCJsZWdlbmRUZXh0IjoiQlJJREdFU1RPTkUgUENUIiwibGFiZWwiOiJCUklER0VTVE9ORSBQQ1QifSx7InkiOjgsImxlZ2VuZFRleHQiOiJUSVRBTiIsImxhYmVsIjoiVElUQU4ifSx7InkiOjQsImxlZ2VuZFRleHQiOiJBUkNUSUMiLCJsYWJlbCI6IkFSQ1RJQyJ9LHsieSI6MSwibGVnZW5kVGV4dCI6IkxFQURFUlRSRUFEIiwibGFiZWwiOiJMRUFERVJUUkVBRCJ9LHsieSI6MSwibGVnZW5kVGV4dCI6IlJFQ0FNSUMiLCJsYWJlbCI6IlJFQ0FNSUMifV0gICAgICAgICAgICAgICAgICAgIC8veVZhbHVlRm9ybWF0U3RyaW5nOiAiIywjIzAsLC4jIyBNaWxsaW9uIiwKICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIF0KICAgICAgICAgICAgfSk7CiAgICAgICAgICAgIGNoYXJ0LnJlbmRlcigpOwogICAgICAgICAgICBjaGFydC5sZWdlbmQuc2V0KCJmb250V2VpZ2h0IiwgbGVnZW5kX2ZvbnRXZWlnaHQpOwogICAgICAgICAgICBjaGFydC5sZWdlbmQuc2V0KCJmb250U2l6ZSIsIGxlZ2VuZF9mb250U2l6ZSk7CiAgICAgICAgICAgIGNoYXJ0LmxlZ2VuZC5zZXQoImZvbnRGYW1pbHkiLCBsZWdlbmRfZm9udEZhbWlseSk7CiAgICAgICAgICAgIGNoYXJ0LmxlZ2VuZC5zZXQoImZvbnRDb2xvciIsIGxlZ2VuZF9mb250Q29sb3IpOwoKICAgICAgICB9CiAgICAgICAgPC9zY3JpcHQ+CiAgICAgICAgPGRpdiBpZD0ibWFya2V0c2hhcmVncmFwaHNzc3MiIGNsYXNzPSJjYW52YXNqcyIgc3R5bGU9ImhlaWdodDogNDAwcHg7IHdpZHRoOiAxMDAlOyI+PC9kaXY+CiAgICAgICAg"
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
POST/api/graphs/canvas-js-pie

This endpoint will allow you to get a single record

URI Parameters

  1. graph_id (required) NO special characters, no spaces

  2. graph_title (required)

  3. data (required) json string

Returned values

  1. data This value is base64 encoded

Saf Header

Resources related to maintenance in the API.

Saf Header is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-header
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 54781,
        "bcd_customer_projects_id": 9,
        "fleet_consultant_id": null,
        "bcd_customer_projects_id_title": null,
        "num_vehicles_in_fleet": 11,
        "pull_point": 11,
        "pressure_variance_perc": 11,
        "high_pressure_variance_perc": 11,
        "max_tread_depth_diff_tolerance": 11,
        "total_rolling_wheels": 11,
        "last_vehicle_info": null,
        "total_vehicles_to_audit": 11,
        "contact_person": "Mbusi Testing",
        "created_at": "2022-07-06 16:07:47",
        "updated_at": "2022-07-06 16:07:47",
        "deleted_at": null
    },
],
"meta": {
    "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "prev_page_url": null,
        "next_page_url": "https://laravel.bandag.zerobox.co.za/api/saf-header?page=2"
    }
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-header

This endpoint will allow you to get the Saf Header in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“contact_person”: “asc”},
    • {“total_vehicles_to_audit”: “asc”},
    • {“num_vehicles_in_fleet”: “asc”},
    • {“pull_point”: “asc”}
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-header
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
    "ref_key": "2222",
    "bcd_customer_projects_id": 9,
    "fleet_consultant_id": 5,
    "bcd_customer_projects_id_title": null,
    "num_vehicles_in_fleet": 11,
    "pull_point": 11,
    "pressure_variance_perc": 11,
    "high_pressure_variance_perc": 11,
    "max_tread_depth_diff_tolerance": 11,
    "total_rolling_wheels": 11,
    "last_vehicle_info": "",
    "total_vehicles_to_audit": 11,
    "contact_person": "Mbusi Testing"
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-header

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_customer_projects_id (numeric, required) This is the column you want to update

    • must exist in table bcd_customer_projects

  3. fleet_consultant_id (numeric, required) This is the column you want to update

  4. num_vehicles_in_fleet (numeric) This is the column you want to update

  5. pull_point (numeric) This is the column you want to update

  6. pressure_variance_perc (numeric) This is the column you want to update

  7. high_pressure_variance_perc (numeric) This is the column you want to update

  8. max_tread_depth_diff_tolerance (numeric) This is the column you want to update

  9. total_rolling_wheels (numeric) This is the column you want to update

  10. last_vehicle_info (max:255) This is the column you want to update

  11. total_vehicles_to_audit (numeric) This is the column you want to update

  12. contact_person (numeric) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-header/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 9,
    "bcd_customer_projects_id": 9,
    "fleet_consultant_id": 5,
    "bcd_customer_projects_id_title": null,
    "num_vehicles_in_fleet": 27,
    "pull_point": 3,
    "pressure_variance_perc": 10,
    "high_pressure_variance_perc": 0,
    "max_tread_depth_diff_tolerance": 3,
    "total_rolling_wheels": 0,
    "last_vehicle_info": "",
    "total_vehicles_to_audit": 27,
    "contact_person": "MR F WOOD",
    "created_at": "2022-07-06 15:07:23",
    "updated_at": "2022-07-06 15:07:23",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-header/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-header
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    "id": 9,
    "bcd_customer_projects_id": 9,
    "fleet_consultant_id": 5,
    "bcd_customer_projects_id_title": null,
    "num_vehicles_in_fleet": 27,
    "pull_point": 3,
    "pressure_variance_perc": 10,
    "high_pressure_variance_perc": 0,
    "max_tread_depth_diff_tolerance": 3,
    "total_rolling_wheels": 0,
    "last_vehicle_info": "",
    "total_vehicles_to_audit": 27,
    "contact_person": "MR F WOOD"
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-header

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_customer_projects_id (numeric, required) This is the column you want to update

    • must exist in table bcd_customer_projects

  4. fleet_consultant_id (numeric, required) This is the column you want to update

  5. num_vehicles_in_fleet (numeric) This is the column you want to update

  6. pull_point (numeric) This is the column you want to update

  7. pressure_variance_perc (numeric) This is the column you want to update

  8. high_pressure_variance_perc (numeric) This is the column you want to update

  9. max_tread_depth_diff_tolerance (numeric) This is the column you want to update

  10. total_rolling_wheels (numeric) This is the column you want to update

  11. last_vehicle_info (max:255) This is the column you want to update

  12. total_vehicles_to_audit (numeric) This is the column you want to update

  13. contact_person (numeric) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-header/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-header/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_customer_projects_id (numeric, required) This is the column you want to update

    • must exist in table bcd_customer_projects

  3. fleet_consultant_id (numeric, required) This is the column you want to update

  4. num_vehicles_in_fleet (numeric) This is the column you want to update

  5. pull_point (numeric) This is the column you want to update

  6. pressure_variance_perc (numeric) This is the column you want to update

  7. high_pressure_variance_perc (numeric) This is the column you want to update

  8. max_tread_depth_diff_tolerance (numeric) This is the column you want to update

  9. total_rolling_wheels (numeric) This is the column you want to update

  10. last_vehicle_info (max:255) This is the column you want to update

  11. total_vehicles_to_audit (numeric) This is the column you want to update

  12. contact_person (numeric) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-header/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "https://laravel.bandag.zerobox.co.za/storage/excel/2022-01-17 09:20:07-saf-header.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-header/export

This endpoint will allow you to Export the saf-header information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“description”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-header/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-header/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Saf Vehicle Header

Resources related to maintenance in the API.

Saf Vehicle Header is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1030633,
      "vehicle_layouts_id": 7,
      "vehicle_layouts_title": "6x4 Horse",
      "vehicle_types_id": 1,
      "vehicle_types_title": "Truck Tractor",
      "bcd_customer_projects_id": 506,
      "vehicle_registration": "rvh068gp",
      "vehicle_odo": null,
      "rec_steer_pressure": 800,
      "rec_drive_pressure": 650,
      "rec_trailer_pressure": 0,
      "total_vehicle_tyre_postions": 10,
      "total_spare_wheels": 0,
      "updated_at": "2022-07-07 15:07:02",
      "deleted_at": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": "https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header?page=2",
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/saf-vehicle-header

This endpoint will allow you to get the Saf Vehicle Header in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”}
  • ]

Records per page

  1. records_per_page (numeric) Optional for pagination,

  2. Default = 10

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 1 = Show trashed records
    • 0 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"2222",
        "vehicle_layouts_id": 7,
        "vehicle_types_id": "1",
        "bcd_customer_projects_id": 506,
        "vehicle_registration": "rvh068gp",
        "vehicle_odo": "",
        "rec_steer_pressure": 800,
        "rec_drive_pressure": 650,
        "rec_trailer_pressure": 0,
        "total_vehicle_tyre_postions": 10,
        "total_spare_wheels": 0
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-vehicle-header

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_customer_projects_id (required) This is the column you want to update

    • must exist in table bcd_customer_projects

  3. vehicle_layouts_id (required) This is the column you want to update

    • must exist in table vehicle_layouts

  4. vehicle_types_id (required) This is the column you want to update

    • must exist in table vehicle_types

  5. vehicle_registration (string, max:255) This is the column you want to update

  6. vehicle_odo (numeric) This is the column you want to update

  7. rec_steer_pressure (numeric) This is the column you want to update

  8. rec_drive_pressure (numeric) This is the column you want to update

  9. rec_trailer_pressure (numeric) This is the column you want to update

  10. total_vehicle_tyre_postions (numeric) This is the column you want to update

  11. total_spare_wheels (numeric) This is the column you want to update

Show

GET https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": {
    "id": 8144,
    "vehicle_layouts_id": 7,
    "vehicle_layouts_title": "6x4 Horse",
    "vehicle_types_id": 1,
    "vehicle_types_title": "Truck Tractor",
    "bcd_customer_projects_id": 506,
    "vehicle_registration": "5231",
    "vehicle_odo": "",
    "rec_steer_pressure": 800,
    "rec_drive_pressure": 650,
    "rec_trailer_pressure": 0,
    "total_vehicle_tyre_postions": 10,
    "total_spare_wheels": 0,
    "updated_at": "2022-07-07 14:07:31",
    "deleted_at": null
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/saf-vehicle-header/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"test",
        "id": 7048,
        "bcd_customer_projects_id": 5,
        "bcd_customer_projects_code": "SP-MG",
        "vehicle_layouts_id": 16,
        "vehicle_layouts_title": "FINANCIAL DIRECTOR/MANAGER",
        "contact_person": "Mbusi Tester",
        "telephone": "27215507305",
        "email": "ml@deta.co.za",
        "cell": "27825615465",
        "day": 0,
        "month": 0
    }
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/saf-vehicle-header

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. bcd_customer_projects_id (required) This is the column you want to update

    • must exist in table bcd_customer_projects

  4. vehicle_layouts_id (required) This is the column you want to update

    • must exist in table vehicle_layouts

  5. vehicle_types_id (required) This is the column you want to update

    • must exist in table vehicle_types

  6. vehicle_registration (string, max:255) This is the column you want to update

  7. vehicle_odo (numeric) This is the column you want to update

  8. rec_steer_pressure (numeric) This is the column you want to update

  9. rec_drive_pressure (numeric) This is the column you want to update

  10. rec_trailer_pressure (numeric) This is the column you want to update

  11. total_vehicle_tyre_postions (numeric) This is the column you want to update

  12. total_spare_wheels (numeric) This is the column you want to update

Import

POST https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header/import
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
    "file": "filename.xlsx",

}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Imported successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Import
POST/api/saf-vehicle-header/import

This endpoint will allow you to Import records.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

  3. file needs to be a field type upload

Excel Columns Structure

  1. id (numeric, optional) if not supplied, a new record will be created

  2. bcd_customer_projects_id (required) This is the column you want to update

    • must exist in table bcd_customer_projects

  3. vehicle_layouts_id (required) This is the column you want to update

    • must exist in table vehicle_layouts

  4. vehicle_types_id (required) This is the column you want to update

    • must exist in table vehicle_types

  5. vehicle_registration (string, max:255) This is the column you want to update

  6. vehicle_odo (numeric) This is the column you want to update

  7. rec_steer_pressure (numeric) This is the column you want to update

  8. rec_drive_pressure (numeric) This is the column you want to update

  9. rec_trailer_pressure (numeric) This is the column you want to update

  10. total_vehicle_tyre_postions (numeric) This is the column you want to update

  11. total_spare_wheels (numeric) This is the column you want to update

Export

POST https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header/export
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/Tyre-Sizes-2022-02-11-20-42-34.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Export
POST/api/saf-vehicle-header/export

This endpoint will allow you to Export the vehicle_layouts information to excel or PDF.

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> form-urlencoded tab on postman

Export Type

export_type options below allow user to send email or get exported file link

  1. [1 = Export Excel link]
  2. [2 = Email Excel file]
  3. [3 = Export PDF link]
  4. [4 = Email PDF file]

Email Address

  1. email Only required for email options

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“telephone”: “asc”},
  • ]

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/saf-vehicle-header/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/saf-vehicle-header/{id}

This endpoint will allow you to delete a record

Activity log

  1. log_name (string, required) This will be the activity log name eg (Fleed Details)

URI Parameters

  1. id (string, required) The record ID
GET https://laravel.bandag.zerobox.co.za/api/saf-vehicle-tyre-problems-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Responses200401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "id": 1276,
      "saf_vehicle_header_id": 8762,
      "saf_tyre_problems_id": 1,
      "saf_tyre_problem_title": "Damaged Valve",
      "position": 12,
      "updated_at": "2022-07-07 15:07:05"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 500,
      "current_page": 1,
      "total_pages": 1,
      "next_page_url": null,
      "prev_page_url": null
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
POST https://laravel.bandag.zerobox.co.za/api/saf-vehicle-tyre-problems-link
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Body
records:[
    {
        "ref_key":"111",
        "saf_vehicle_header_id": 75866,
        "vehicle_tyre_problems":[
            {"saf_tyre_problems_id": 3, "position": 2}
        ]
    }
]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/saf-vehicle-tyre-problems-link

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. bcd_end_user_customers_id (required) This is the column you want to update

    • must exist in table bcd_end_user_customers

  3. vehicle_tyre_problems (array, required) array of services

    • saf_tyre_problems_id (required) This is the column you want to update
      • must exist in table saf_tyre_problems
    • position (optional) This is the column you want to update
GET https://laravel.bandag.zerobox.co.za/api/saf-vehicle-tyre-problems-link/{id}
Requestsexample 1example 2
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
{
"success": true,
"data": {
        "id": 8762,
        "saf_vehicle_header_id": 75866,
        "saf_tyre_problems_id": 3,
        "saf_tyre_problem_title": "Missing Valve Cap",
        "position": 2,
        "updated_at": "2022-07-07 15:07:26"
    }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Body
{
  "export_type": "1",
  "email": "example@domain.co.za",
  "start_date": "2022-01-01",
  "end_date": "2022-01-01"
}
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": "http://127.0.0.1:8000/storage/excel/saf-vehicle-tyre-problems-link-2022-02-21-21-38-09.xlsx"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
DELETE https://laravel.bandag.zerobox.co.za/api/saf-vehicle-tyre-problems-link/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

User Roles

Resources related to maintenance in the API.

User Roles is a simple maintenance API

List All

GET https://laravel.bandag.zerobox.co.za/api/user-roles
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: form-data
Content-Type: x-www-form-urlencoded
Responses200401403404
Headers
Content-Type: application/json
Body
{
"success": true,
"data": [
    {
        "id": 6,
        "name": "Super Admin",
        "guard_name": "web",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 20:01:36",

},
{
    "id": 7,
    "name": "Super Admin",
    "guard_name": "web",
    "created_at": "2022-01-20 18:01:01",
    "updated_at": "2022-01-20 18:01:01",
    "deleted_at": null
}
]
}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List All
GET/api/user-roles

This endpoint will allow you to get the User Roles in the system

Parameter Form Data

  1. The parameters on this end point are of type GET query string

  2. They go under Params tab on postman

Start Date and End Date

  1. start_date {2022-01-01} Optional for filtering

  2. end_date {2022-01-31} Optional for filtering

  3. Both has to be supplied for filtering

  4. If only one is supplied filtering wont work

  5. The date range must always be in between the range of data required to be filtered

Search

  1. search Optional for filtering

Ordering

  1. order_by Optional for ordering

  2. Available options [

    • {“id”: “asc”},
    • {“name”: “asc”},
    • {“guard_name”: “asc”},
  • ]

Trashed records

  1. trash_records (numeric) Optional for retrieving trashed records

  2. Available Options

    • 0 = Default - non trash record shown
    • 1 = Show trashed records
    • 2 = Don’t show trashed records

Store

POST https://laravel.bandag.zerobox.co.za/api/user-roles/multiple
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Body
+ Headers

    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
    Content-Type: form-data
    Content-Type: x-www-form-urlencoded

+ Body

    records:[
        {"ref_key":"111", "name":"Super Admin", "guard_name": "web" },
        {"ref_key":"112", "name":"Super Admin", "guard_name": "api" },
    ]
Responses201422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "data": [
    {
      "name": "Super Admin",
      "guard_name": "web",
      "created_at": "2022-01-20T18:55:50.082553Z",
      "updated_at": "2022-01-20T18:55:50.082566Z"
    },
    {
      "name": "Super Admin",
      "guard_name": "web",
      "created_at": "2022-01-20T18:55:50.082574Z",
      "updated_at": "2022-01-20T18:55:50.082580Z"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Store
POST/api/user-roles/multiple

This endpoint will allow you to create records

Parameter Form Data

  1. The parameters on this end point are of type POST

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. name (string, reqired) This is the column you want to store

  3. guard_name (string, reqired) This is the column you want to store

Show

GET https://laravel.bandag.zerobox.co.za/api/user-roles/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses200401403404
Headers
Content-Type: application/json
Body
{
    "success": true,
    "data": {
        "id": 5,
        "name": "Super Admin",
        "guard_name": "web",
        "created_at": "2022-01-20 18:01:01",
        "updated_at": "2022-01-20 18:01:01",

}
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/api/user-roles/{id}

This endpoint will allow you to get a single record

URI Parameters

  1. id (numeric, required) The record ID

Update

PATCH https://laravel.bandag.zerobox.co.za/api/user-roles/multiple
Requestsexample 1
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Content-Type: x-www-form-urlencoded
Content-Type: form-data
Body
records:[
    {"ref_key":"111", "name":"Super Admin", "guard_name": "web" },
    {"ref_key":"112", "name":"Super Admin", "guard_name": "super admin" },
]
Responses200422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Update successful!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/api/user-roles/multiple

This endpoint will allow you to update multiple records, in this case the payload will have to contain all the entity to be updated.

Parameter Form Data

  1. The parameters on this end point are of type PATCH

  2. They go under Body >> x-www-form-urlencoded tab on postman

records

  1. ref_key (string, required) This is the unique identifier key

  2. id (numeric, required) This is the record id to update

  3. name (string, required) This is the column you want to update

  4. guard_name (string, required) This is the column you want to update

Delete Record

DELETE https://laravel.bandag.zerobox.co.za/api/user-roles/{id}
Requestsexample 1
Headers
Content-Type: application/vnd.api.v1+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjBlOGVhOGY0YWY2Yjg3NzU0YjZjZDBjNjdkNzBmMjdhYTZkMmRjNjU3YzIwYTU0MjQ3NWRlZGU4Y2VkNTc1N2IwZDcwMWFmNTAyMGU4MGE4In0.eyJhdWQiOiIxIiwianRpIjoiMGU4ZWE4ZjRhZjZiODc3NTRiNmNkMGM2N2Q3MGYyN2FhNmQyZGM2NTdjMjBhNTQyNDc1ZGVkZThjZWQ1NzU3YjBkNzAxYWY1MDIwZTgwYTgiLCJpYXQiOjE0NzYyOTk1NTQsIm5iZiI6MTQ3NjI5OTU1NCwiZXhwIjoxNDc3NTk1NTU0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.gTOotTVp2eF_HvuW48ngGqdly4bocNMlvY0al0YmYPJ_tjBQYegE4AjtCH2bWUf9aUz8tQqhMr2UFae3JV6VDQC9VzoGK8gU_nulM0BkqaCCxadqrw_slcd4he9hT0FE3WshvdZKcmgaVovgrI2-sAnX3n749BiWtWLEpw6x-TdEHEVcW6uRfRWyrwKhPBfOk-hXpgbecgT8LYdBW531P1ryjSJzzi5zBEe0Ecbp9Lo-fV69AW8ZBnG1DBjzxW-hvE0rRLXXnI4-f9rbQfK6QUzfG3Dg2INexcKxu9sQ3Vn5wHhQyu4_nTNQh8rsgphdAqFnEo-FQZrRWejkKbOi_BcpQybaXNn7Qln-96QF6PAzT-2E08VmL4XeVNcSvmM1sPVwirnSXo4UIFSsHvvIdVfEYEXD8XDonlnVO74RgBDMXWs6xo7dmDNaqQxKt9J_s_xtmyM3w62C4QucKw7MY0zOqviEyXySbrYbgazO_Pl1--GXtksE8tVMW8OW6Y8fw0JE0GEd5hZVadR277A5164QAJhiGXI_mKNTtUZVNaj0JpKEQpu4tod_BJR_DxzvcpKHwc1YrfrPOul6mL4kZeafkehPe79jxrCXKgKEuGlgSFcyrXUNCtME9LxsMID6QpJ-tfx4i0jqjixd_smqpjPPYqhPuqhox3uMLcDgM6s
Responses204422401403404
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "Record deleted successfully!"
}
Headers
Content-Type: application/json
Body
{
  "message": "Validation error",
  "errors": [],
  "status_code": 422
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "errors": {},
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Unauthenticated.",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "Forbidden",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "message": "404 Not found",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete Record
DELETE/api/user-roles/{id}

This endpoint will allow you to delete a record

URI Parameters

  1. id (string, required) The record ID

Generated by aglio on 04 Jun 2024