CARVAK APIs

Tüm API'lerin dokümantasyonu.

PreviousEkspertiz Entegrasyonu

Last updated 1 year ago

Create a new repair

post

Authorizations

Body

Responses

200

Repair created successfully

application/json

403

Forbidden

application/json

post

POST /api/setCarvakRepair HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "dealer_info": {
    "id": 1
  },
  "customer_info": {
    "name_surname": "text",
    "phone": {
      "number": "text"
    }
  },
  "car_info": {
    "plate_number": "text",
    "chassis_number": "text",
    "make": "text",
    "model": "text"
  },
  "package": {
    "id": 1,
    "price": "text",
    "moduls": [
      {
        "id": 1,
        "price": "text"
      }
    ]
  },
  "appointment_info": {
    "date": "text",
    "time": "text"
  }
}

{
  "status": true,
  "data": {
    "id": 1,
    "customerId": 1
  }
}

Get list of Carvak modules

get

Authorizations

Responses

200

Successful response

application/json

403

Forbidden

application/json

get

GET /api/getCarvakModules HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Accept: */*

{
  "status": true,
  "data": [
    {
      "id": 1,
      "title": "text",
      "icon_url": "text",
      "question_count": 1
    }
  ]
}

Retrieve questions for a specific module by its ID

get

Authorizations

Query parameters

module_idstringRequired

The ID of the module to retrieve questions for

Responses

200

A list of questions for the module

application/json

403

Forbidden

application/json

get

GET /api/getCarvakModuleQuestions HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Accept: */*

{
  "status": true,
  "data": [
    {
      "id": 1,
      "title": "text",
      "question_is_required": "text",
      "question_comment": "text",
      "question_photo_comment": "text",
      "is_active": "text",
      "question_order": 1,
      "lang_code": "text",
      "photo_overlay": "text",
      "question_answers": [
        {
          "id": 1,
          "title": "text",
          "answer_comment": "text",
          "order": 1,
          "short_code": "text",
          "color": "text",
          "comment_required": "text",
          "photo_required": "text",
          "answer_rate_id": 1
        }
      ],
      "answer_type": {
        "id": 1,
        "title": "text",
        "comment": "text"
      }
    }
  ]
}

Get all answer types

get

Authorizations

Responses

200

A list of all available answer types

application/json

403

Forbidden

application/json

get

GET /api/getCarvakAnswerTypes HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Accept: */*

{
  "status": true,
  "data": [
    {
      "id": 1,
      "title": "text",
      "comment": "text"
    }
  ]
}

Get all answers

get

Authorizations

Responses

200

A list of all answers

application/json

403

Forbidden

application/json

get

GET /api/getCarvakAnswers HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Accept: */*

{
  "status": true,
  "data": [
    {
      "id": 1,
      "title": "text",
      "answer_comment": "text",
      "order": 1,
      "short_code": "text",
      "color": "text",
      "comment_required": "text",
      "photo_required": "text",
      "answer_rate_id": 1
    }
  ]
}

Update a specific question for a module

post

Authorizations

Body

question_idintegerOptional

Required - The ID of the module the question belongs to

question_is_activebooleanOptional

Optional - Whether the question is active or not

lang_codestringOptional

Optional - The language code for the question. Defaults to tr.

question_titlestringOptional

Optional - The title of the question

question_commentstringOptional

Optional - The comment for the question

question_photo_commentstringOptional

Optional - The photo comment for the question

photo_overlaystringOptional

Optional - The photo overlay for the question that will be displayed on the camera screen

question_orderintegerOptional

Optional - The order of the question

question_answer_type_idintegerOptional

Optional - The ID of the answer type for the question

Responses

200

Question updated successfully

application/json

403

Forbidden

application/json

post

POST /api/updateCarvakModuleQuestion HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "question_id": 1,
  "question_is_active": true,
  "lang_code": "text",
  "question_title": "text",
  "question_comment": "text",
  "question_photo_comment": "text",
  "photo_overlay": "text",
  "question_order": 1,
  "question_answer_type_id": 1,
  "question_answers": []
}

{
  "status": true,
  "message": "text"
}

Insert a new question for a module

post

Authorizations

Body

question_module_idintegerOptional

Required - The ID of the module the question belongs to

lang_codestringOptional

Optional - The language code for the question. Defaults to tr.

question_titlestringOptional

Required - The title of the question

question_commentstringOptional

Optional - The comment for the question

question_photo_commentstringOptional

Optional - The photo comment for the question

photo_overlaystringOptional

Optional - The photo overlay for the question that will be displayed on the camera screen

question_orderintegerOptional

Optional - The order of the question

question_answer_type_idintegerOptional

Required - The ID of the answer type for the question

question_answersinteger[]Optional

Required if question_answer_type_id is 1 or 2 - The IDs of the answers for the question - int[]

Responses

200

Question inserted successfully

application/json

403

Forbidden

application/json

post

POST /api/insertCarvakModuleQuestion HTTP/1.1
Host: ares.rsservis.com.tr
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "question_module_id": 1,
  "lang_code": "text",
  "question_title": "text",
  "question_comment": "text",
  "question_photo_comment": "text",
  "photo_overlay": "text",
  "question_order": 1,
  "question_answer_type_id": 1,
  "question_answers": [
    1
  ]
}

{
  "status": true,
  "question_id": "text"
}