/var/www/html/back/.scribe/endpoints.cache/08.yaml
## Autogenerated by Scribe. DO NOT MODIFY.
name: projects
description: ''
endpoints:
-
httpMethods:
- GET
uri: 'api/v1/project/{modelID}/list'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Получить список всех проектов.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters:
search:
name: search
description: 'Поисковый запрос для фильтрации проектов. Пример: "Laravel"'
required: false
example: eum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
project_group_id:
name: project_group_id
description: 'ID категории для фильтрации проектов. Пример: 3'
required: false
example: 18
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
payment_id:
name: payment_id
description: 'ID платежа. Пример: 3'
required: false
example: 15
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
search: eum
project_group_id: 18
payment_id: 15
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer a1afVhd46v8D3P6cE5beZgk'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/project/{modelID}/payments/export'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Экспортировать платежи в Excel, результат = url для скачивания'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters:
ids:
name: ids
description: '- список ID проектов для экспорта'
required: false
example:
- magni
type: 'string[]'
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
ids:
- magni
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 6bZVEeaP4ch5f1Dd8avg6k3'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/project/{modelID}/with-payments'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Получить список всех проектов с платежами.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters:
search:
name: search
description: 'Поисковый запрос для фильтрации проектов. Пример: "Laravel"'
required: false
example: expedita
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
project_group_id:
name: project_group_id
description: 'ID категории для фильтрации проектов. Пример: 3'
required: false
example: 13
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
payment_id:
name: payment_id
description: 'ID платежа. Пример: 3'
required: false
example: 9
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
search: expedita
project_group_id: 13
payment_id: 9
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 8f6aVDE4chkv1e5ZP6gbd3a'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/project/{modelID}/grouped-list'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Получить список всех проектов с группировкой по группам и еще список проектов вне групп (через generic группу)'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters:
search:
name: search
description: 'Поисковый запрос для фильтрации проектов. Пример: "Laravel"'
required: false
example: maiores
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
sorting:
name: sorting
description: 'сортировка, пример sort=article&sort_direction=ASC'
required: false
example:
- reprehenderit
type: 'string[]'
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
search: maiores
sorting:
- reprehenderit
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer ghDZ6bf4Eead3a8VkP165vc'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/project/{modelID}/{projectID}'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Получить проект по ID.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
projectID:
name: projectID
description: ''
required: true
example: eius
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
projectID: eius
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 3daVbDkf6EP56ea1Zcvgh84'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/project/{modelID}/{projectID}/payments'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Сумма платежей по проекту'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
projectID:
name: projectID
description: ''
required: true
example: odit
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
projectID: odit
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer Z4avh6cbg1kaD83Pfe56VdE'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/project/{modelID}/create'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Создать новый проект.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters: []
cleanQueryParameters: []
bodyParameters:
project_limits:
name: project_limits
description: project_limits.
required: true
example: 1.85384533
type: number
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
status:
name: status
description: 'status. Длина поля value не должна превышать 255 символов.'
required: true
example: urnpspogmnh
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
offer_number:
name: offer_number
description: 'offer_number. Длина поля value не должна превышать 255 символов.'
required: true
example: hcoqczhcvwyn
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
object_address:
name: object_address
description: 'object_address. Длина поля value не должна превышать 255 символов.'
required: true
example: nagzqhszdzjbtnbkvxytcjr
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
short_description:
name: short_description
description: 'short_description. Длина поля value не должна превышать 500 символов.'
required: true
example: 'y'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
description:
name: description
description: description.
required: false
example: 'Eos quo officiis autem ut at.'
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
project_group_id:
name: project_group_id
description: 'project_group_id. The <code>id</code> of an existing record in the project_groups table.'
required: false
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
project_limits: 1.85384533
status: urnpspogmnh
offer_number: hcoqczhcvwyn
object_address: nagzqhszdzjbtnbkvxytcjr
short_description: 'y'
description: 'Eos quo officiis autem ut at.'
project_group_id: 6
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer V1eh4b365aEgk8ZdP6cafvD'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/project/{modelID}/{projectID}/update'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Обновить существующий проект.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
projectID:
name: projectID
description: ''
required: true
example: reiciendis
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
projectID: reiciendis
queryParameters: []
cleanQueryParameters: []
bodyParameters:
project_limits:
name: project_limits
description: project_limits.
required: false
example: 1.71708141
type: number
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
status:
name: status
description: 'status. Длина поля value не должна превышать 255 символов.'
required: false
example: xnkp
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
offer_number:
name: offer_number
description: 'offer_number. Длина поля value не должна превышать 255 символов.'
required: false
example: azcmzllnxxicskinmivnjng
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
object_address:
name: object_address
description: 'object_address. Длина поля value не должна превышать 255 символов.'
required: false
example: sjq
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
short_description:
name: short_description
description: 'short_description. Длина поля value не должна превышать 500 символов.'
required: false
example: viqkswmqjzunqagcbxz
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
description:
name: description
description: description.
required: false
example: 'Modi sint qui ut unde odio sapiente cupiditate placeat.'
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
project_group_id:
name: project_group_id
description: 'project_group_id. The <code>id</code> of an existing record in the project_groups table.'
required: false
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
project_limits: 1.71708141
status: xnkp
offer_number: azcmzllnxxicskinmivnjng
object_address: sjq
short_description: viqkswmqjzunqagcbxz
description: 'Modi sint qui ut unde odio sapiente cupiditate placeat.'
project_group_id: 1
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer eca1Z856ag4bDf6VkPd3Evh'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/v1/project/{modelID}/{projectID}'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Удалить проект.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
projectID:
name: projectID
description: ''
required: true
example: excepturi
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
projectID: excepturi
queryParameters:
new_project_id:
name: new_project_id
description: '- ID проекта для переноса платежей (опционально)'
required: false
example: 2
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
new_project_id: 2
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":{"status":true,"message":null,"errors":null,"data":[],"pagination":null},"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 5P6dh34Za81DcbeEaf6Vvgk'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/project-group/{modelID}/list'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Получить список групп проектов.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer h3baaDZf5c6gkVv8e16Pd4E'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/project-group/{modelID}/{groupID}'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Получить группу по ID.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
groupID:
name: groupID
description: ''
required: true
example: occaecati
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
groupID: occaecati
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer vafk8bZhc31E6edgP6DVa54'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/project-group/{modelID}/create'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Создать новую группу.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
queryParameters:
name:
name: name
description: ''
required: false
example: commodi
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
description:
name: description
description: ''
required: false
example: 'Possimus est et commodi totam voluptate.'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
projects:
name: projects
description: 'array[]'
required: false
example: vitae
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
name: commodi
description: 'Possimus est et commodi totam voluptate.'
projects: vitae
bodyParameters:
name:
name: name
description: 'name. Длина поля value не должна превышать 255 символов.'
required: true
example: plvuptciuh
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
description:
name: description
description: 'description. Длина поля value не должна превышать 255 символов.'
required: false
example: 'Iusto quibusdam est officiis cumque iste.'
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
projects:
name: projects
description: 'projects ids.'
required: false
example: null
type: object
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
name: plvuptciuh
description: 'Iusto quibusdam est officiis cumque iste.'
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer fbD8VaE4Z5ad6hPgke1v63c'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/project-group/{modelID}/{id}/update'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Обновить существующую группу.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the {modelID}.'
required: true
example: nemo
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
id: nemo
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'name. Длина поля value не должна превышать 255 символов.'
required: true
example: jr
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: jr
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":null,"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 1ck3dP458avVhg6bZfEaeD6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/v1/project-group/{modelID}/{groupID}'
metadata:
groupName: projects
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: 'Удалить группу.'
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer Bearer {YOUR_AUTH_KEY}'
Content-Type: multipart/form-data
Accept: application/json
urlParameters:
modelID:
name: modelID
description: ''
required: true
example: 6
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
groupID:
name: groupID
description: ''
required: true
example: animi
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 6
groupID: animi
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message":null,"errors":null,"data":{"status":true,"message":null,"errors":null,"data":[],"pagination":null},"status":true}'
headers: []
description: Ok
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer fgaPkdc81ZD5Va6h3Eeb4v6'
controller: null
method: null
route: null
custom: []