/
var
/
www
/
html
/
back
/
.scribe
/
endpoints
/
Upload File
HOME
name: accounts description: '' endpoints: - httpMethods: - GET uri: 'api/v1/account/{modelID}/list' metadata: groupName: accounts 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: et type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanQueryParameters: search: et bodyParameters: search: name: search description: 'search term.' required: false example: temporibus type: string enumValues: [] exampleWasSpecified: false nullable: true custom: [] cleanBodyParameters: search: temporibus fileParameters: [] responses: - status: 401 content: '{"message":"Unauthenticated."}' headers: cache-control: 'no-cache, private' content-type: application/json access-control-allow-origin: '*' description: null custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer ED5ka1664hfe3vgdPabcV8Z' controller: null method: null route: null custom: [] - httpMethods: - GET uri: 'api/v1/account/{modelID}/{id}' metadata: groupName: accounts 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: officia type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: officia queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 401 content: '{"message":"Unauthenticated."}' headers: cache-control: 'no-cache, private' content-type: application/json access-control-allow-origin: '*' description: null custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer 4V5aZc8DkbaPgf1v3d6hE6e' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/v1/account/{modelID}/create' metadata: groupName: accounts 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: model_id: name: model_id description: 'ID модели, к которой привязан счет. The <code>id</code> of an existing record in the models table.' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] name: name: name description: 'Название счета. Длина поля value не должна превышать 255 символов.' required: true example: 'Основной счет' type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] organization_id: name: organization_id description: 'ID организации, связанной со счетом. The <code>id</code> of an existing record in the organizations table.' required: true example: 2 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] deposit: name: deposit description: 'Начальный депозит счета.' required: true example: 1000.5 type: number enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanBodyParameters: model_id: 1 name: 'Основной счет' organization_id: 2 deposit: 1000.5 fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":null,"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer ghcfab36dZ6kv5VaD8ePE41' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/v1/account/{modelID}/{id}/update' metadata: groupName: accounts 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: omnis type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: omnis queryParameters: [] cleanQueryParameters: [] bodyParameters: model_id: name: model_id description: 'ID модели, к которой привязан счет (необязательно). The <code>id</code> of an existing record in the models table.' required: false example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] name: name: name description: 'Название счета (необязательно). Длина поля value не должна превышать 255 символов.' required: false example: 'Резервный счет' type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] organization_id: name: organization_id description: 'ID организации, связанной со счетом (необязательно). The <code>id</code> of an existing record in the organizations table.' required: false example: 3 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] deposit: name: deposit description: 'Обновленное значение депозита счета (необязательно).' required: false example: 5000.0 type: number enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanBodyParameters: model_id: 1 name: 'Резервный счет' organization_id: 3 deposit: 5000.0 fileParameters: [] responses: - status: 200 content: '{"message":null,"errors":null,"data":null,"status":true}' headers: [] description: Ok custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer hD6Zegdf3a68V14avkPcEb5' controller: null method: null route: null custom: [] - httpMethods: - DELETE uri: 'api/v1/account/{modelID}/{id}' metadata: groupName: accounts 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: nam type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: modelID: 1 id: nam queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: [] responseFields: [] auth: - headers - Authorization - 'Bearer adk6bcv8fP615E4hD3geaZV' controller: null method: null route: null custom: []