GetOrganization¶
Метод GetOrganization
возвращает информацию об организации в Диадоке.
- GET /GetOrganization¶
- Query Parameters:
orgId – идентификатор организации. Необязательный параметр.
boxId – идентификатор ящика организации. Необязательный параметр.
fnsParticipantId – идентификатор участника электронного документооборота. Необязательный параметр.
inn – ИНН организации. Необязательный параметр.
kpp – КПП организации. Необязательный параметр.
- Request Headers:
Authorization – данные, необходимые для авторизации. В заголовке нужно передать
DiadocAuth ddauth_api_client_id
.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
, или в этом заголовке отсутствует параметрddauth_api_client_id
, или переданный в нем ключ разработчика не зарегистрирован в Диадоке.404 Not Found – организация с указанным идентификатором не найдена в справочнике.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит структуру Organization.
В строке запроса должен присутствовать только один из параметров: orgId
, boxId
, fnsParticipantId
или inn
. Параметр kpp
учитывается, если запрос осуществляется с указанием inn
.
В случае поиска по ИНН метод возвращает ответ, только если найдена одна организация, при том, что в Диадоке может быть несколько ящиков с указанным ИНН. Для поиска ящиков по ИНН рекомендуем пользоваться методом GetOrganizationsByInnKpp
В случае поиска по ИНН и КПП, если организация с таким КПП не найдена, то метод вернет головную организацию с указанным ИНН.