Управление организациями

Создание организации

Пример json данных для HTTP запроса:

{
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000"
}


 

Пример HTTP запроса:

curl -X POST https://api.msndr.net/v1/email/organizations \
     -H 'Content-Type: application/json'             \
     -H 'Authorization: Bearer $API_TOKEN'           \
     -d '...JSON...'


 

Здесь используется метод POST и ссылка /email/organizations

Пример ответа в случае успешного запроса:

{
  "id":1,
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000",
  "current":true
}


 

Пояснение параметров json данных для запроса приведено ниже в таблице:

Параметр

Описание

Обязательный

name

Имя организации

                              Да

address

Адрес организации

                              Да

country

Страна где находится организация

                              Да

city

Город где находится организация

                              Да

phone

Телефон организации

                              Да

zip

Почтовый индекс

                              Да

Пояснение параметров json ответа от сервера приведено ниже в таблице:

Атрибут                                        Описание

id                                  Идентификатор организации

name                           Название организации

address                        Адрес организации

country                        Страна организации

city                               Город где находится организация

phone                          Телефон организации

zip                                 Почтовый индекс организации

current                        Является ли организацией по умолчанию

9.1               Получение списка организации с помощью HTTP запроса:

 

Пример HTTP запроса:

curl -X GET https://api.msndr.net/v1/email/organizations \
     -H 'Content-Type: application/json'            \
     -H 'Authorization: Bearer $API_TOKEN'

Здесь используется метод GET и ссылка /email/organizations

Ответ в случае успешного выполнения запроса будет примерно следующим:

{
  "total_count":1,
  "total_pages":1,
  "page_number":1,
  "page_size":25,
  "collection":[
    {
      "id":1,
      "name":"My Organization",
      "address":"Lenina 40",
      "country":"Russia",
      "city":"Tomsk",
      "phone":"+7-3822-123-456",
      "zip":"634000",
      "current":true
    }
  ]
}

Пояснение параметров элементов массива организаций ( collection ) json ответа сервера приведено ниже в таблице:

Атрибут

Описание

id

                                                Идентификатор организации

name

                                                Название организации

address

                                                Адрес организации

country

                                                Страна организации

city

                                                Город организации

phone

                                                Телефон организации

zip

                                                Почтовый индекс организации

current

                                                Является ли организацией по умолчанию

 

Получение информации по организации
 
Пример HTTP запроса:

curl -X GET https://api.msndr.net/v1/email/organizations/1 \
     -H 'Content-Type: application/json'              \
     -H 'Authorization: Bearer $API_TOKEN'


Здесь используется метод GET и ссылка /email/organizations/:id
 
Где id это идентификатор организации
 
Пример ответа в случае успешного запроса:

{
  "id":1,
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000",
  "current":true
}


 
Пояснение параметров в json ответе сервера приведено ниже в таблице:

Атрибут                    Описание
id                   Идентификатор организации
name                 Название организации
address                Адрес организации
country                Страна огранизации
city                 Город организации
phone           Телефон организации
zip                  Почтовый индекс организации
current       Является ли организацией по умолчанию

 
Получение организации по умолчанию
 
Пример HTTP запроса:

curl -X GET https://api.msndr.net/v1/email/organizations/current \
     -H 'Content-Type: application/json'                    \
     -H 'Authorization: Bearer $API_TOKEN'


 
Здесь используется метод GET и ссылка /email/organizations/current
 
Пример ответа в случае успешного запроса:

{
  "id":1,
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000",
  "current":true
}


 
Пояснение параметров json ответа сервера приведено ниже в таблице:

Получение организации по умолчанию
 
Пример HTTP запроса:

curl -X GET https://api.msndr.net/v1/email/organizations/current \
     -H 'Content-Type: application/json'                    \
     -H 'Authorization: Bearer $API_TOKEN'


 
Здесь используется метод GET и ссылка /email/organizations/current
 
Пример ответа в случае успешного запроса:

{
  "id":1,
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000",
  "current":true
}


 
Пояснение параметров json ответа сервера приведено ниже в таблице:

Атрибут

                                    Описание

id

                         Идентификатор организации

name

                         Название организации

address

                          Адрес организации

country

                          Страна организации

city

                          Город организации

phone

                          Телефон организации

zip

                          Почтовый индекс организации

current

                          Является ли организацией по умолчанию

 

 

 

 

Задание организации как организации по умолчанию
 
Пример HTTP запроса:

curl -X PATCH https://api.msndr.net/v1/email/organizations/1/current \
     -H 'Content-Type: application/json'                        \
     -H 'Authorization: Bearer $API_TOKEN'


 
Здесь используется метод PATCH и ссылка /email/organizations/:id/current
 
Где id идентификатор организации.
 
Пример ответа в случае успешного запроса:

{
  "id":1,
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000",
  "current":true
}


 
Пояснение параметров json данных ответа от сервера приведено ниже в таблице:
 
Атрибут                                Описание
id                           Идентификатор организации
name                         Название организации
address                      Адрес организации
country                      Страна организации
city                         Город организации
phone                        Телефон организации
zip                          Почтовый индекс организации
current                 Является ли организацией по умолчанию

 

Изменение параметров организации
 
Пример json данных для HTTP запроса:

{
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000"
}


 
Пример HTTP запроса:

curl -X PATCH https://api.msndr.net/v1/email/organizations/1 \
     -H 'Content-Type: application/json'                \
     -H 'Authorization: Bearer $API_TOKEN'              \
     -d '...JSON...'


 
Здесь применяется метод PATCH и
ссылка
/email/organizations/:id

Где id это идентификатор организации
 
Пример ответа в случае успешного HTTP запроса:

{
  "id":1,
  "name":"My Organization",
  "address":"Lenina 40",
  "country":"Russia",
  "city":"Tomsk",
  "phone":"+7-3822-123-456",
  "zip":"634000",
  "current":true
}


 
Поясним  параметры json данных в HTTP запросе в таблице ниже:

Параметр

Описание

Обязательный

name

                               Имя организации

  

address

                               Адрес организации

  

country

                               Страна организации

  

city

                               Город организации

  

phone

                               Телефон организации

  

zip

                                  Почтовый индекс организации

  

 

 

 

 

 

Поясним параметры json ответа от сервера в таблице ниже: 

Атрибут                                             Описание
id                             Идентификатор организации
name                           Название организации
address                        Адрес организации
country                        Страна организации
city                           Город организации
pho                            Телефон организации
zip                            Почтовый индекс организации
current                        Является ли организацией по умолчанию

Удаление организации
 
Пример HTTP запроса:

curl -X DELETE https://api.msndr.net/v1/email/organizations/1 \
     -H 'Content-Type: application/json'                 \
     -H 'Authorization: Bearer $API_TOKEN'


 
Здесь используется метод DELETE и ссылка /email/organizations/:id
 
Где id это идентификатор организации


 

  • 0 Пользователи нашли это полезным
Помог ли вам данный ответ?

Связанные статьи

Управление параметрами групп получателей

Создание параметра группы Пример json данных для HTTP запроса: { "title":"Age", "kind":...

Общие сведения

Через программный интерфейс (далее - API) сервиса email рассылок можно отправлять рассылки,...

Ограничения вводимые сервисом для предотвращения спам рассылки

Для предотвращения спам рассылки , предусмотрен механизм ограничения числа отправлений. В личном...

Получение текущего баланса

Чтобы получить информацию по вашему балансу нужно выполнить следующий HTTP запрос: curl -X GET...

Отправка одного сообщения

Отправка одного email сообщения Пример json данных для запроса: {...

Powered by WHMCompleteSolution