/var/www/html/back/.scribe/endpoints.cache/04.yaml
## Autogenerated by Scribe. DO NOT MODIFY.
name: organizations
description: ''
endpoints:
-
httpMethods:
- GET
uri: 'api/v1/dict/{modelID}/organization/list'
metadata:
groupName: organizations
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: quaerat
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: quaerat
queryParameters:
search:
name: search
description: 'Поисковый запрос для фильтрации. Пример: "Laravel"'
required: false
example: eos
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
search: eos
bodyParameters:
search:
name: search
description: 'search term.'
required: false
example: asperiores
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
search: asperiores
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 583d1hE6efVg4Zbaak6PvDc'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/organizations/{modelID}/list'
metadata:
groupName: organizations
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: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 1
queryParameters:
search:
name: search
description: 'Поисковый запрос для фильтрации. Пример: "Laravel"'
required: false
example: nemo
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanQueryParameters:
search: nemo
bodyParameters:
search:
name: search
description: 'search term.'
required: false
example: velit
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
search: velit
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 V5h1dv6aDa4PkgZ8c6Ebef3'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/v1/organizations/{modelID}/{id}'
metadata:
groupName: organizations
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: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the {modelID}.'
required: true
example: quia
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 1
id: quia
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 aD86Efav5gkPcd6e4hZbV13'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/organizations/{modelID}/create'
metadata:
groupName: organizations
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: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters:
full_name:
name: full_name
description: full_name.
required: true
example: delectus
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
short_name:
name: short_name
description: short_name.
required: true
example: et
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
inn:
name: inn
description: inn.
required: true
example: quis
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
kpp:
name: kpp
description: kpp.
required: true
example: aliquam
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
external_id:
name: external_id
description: external_id.
required: false
example: voluptates
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
api_key:
name: api_key
description: api_key.
required: false
example: quia
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
full_name: delectus
short_name: et
inn: quis
kpp: aliquam
external_id: voluptates
api_key: quia
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 g4P51D3Ecabfvh86a6ekVZd'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/v1/organizations/{modelID}/{id}/update'
metadata:
groupName: organizations
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: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the {modelID}.'
required: true
example: voluptatum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 1
id: voluptatum
queryParameters: []
cleanQueryParameters: []
bodyParameters:
full_name:
name: full_name
description: full_name.
required: true
example: eligendi
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
short_name:
name: short_name
description: short_name.
required: true
example: est
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
inn:
name: inn
description: inn.
required: true
example: iste
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
kpp:
name: kpp
description: kpp.
required: true
example: non
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
external_id:
name: external_id
description: external_id.
required: false
example: eveniet
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
api_key:
name: api_key
description: api_key.
required: false
example: doloremque
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
cleanBodyParameters:
full_name: eligendi
short_name: est
inn: iste
kpp: non
external_id: eveniet
api_key: doloremque
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 6ad5ae4vcD6kZPf3b1EV8hg'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/v1/organizations/{modelID}/{id}'
metadata:
groupName: organizations
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: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the {modelID}.'
required: true
example: quas
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
modelID: 1
id: quas
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer h1E664b8DvgZ5kaeaPfdc3V'
controller: null
method: null
route: null
custom: []