API Reference service (v0.2.1)

Download OpenAPI specification:

Regions

API регионов

Получить регионы

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterRegionsDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"active": true,
"title": "Краснодар",
"timezone": "Europe/Moscow",
"roistatId": "id"
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Organizations

API застройщиков

Создать организацию

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
title required	string <= 255 characters Название региона

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "Застройщик"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись успешно создана"
}

Получить организации

Authorizations:

Bearer

Request Body schema: application/json
required

	object (FilterOrganizationsDto)
	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"active": true,
"title": "Застройщик"
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Обновить организацию

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
active	boolean Активность
title	string <= 255 characters Название организации

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"active": true,
"title": "Застройщик"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись обновлена"
}

Удалить организацию (soft delete)

Authorizations:

Bearer

path Parameters

id

required

string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись удалена"
}

API Reference service (v0.2.1)

Regions

Получить регионы

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Organizations

Создать организацию

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получить организации

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Обновить организацию

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Удалить организацию (soft delete)

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required