Корпоративное API: Списки типов данных в Астрал.Доверенность | Помощь Астрал
Техподдержка:
Отдел продаж
График работы

Астрал.Доверенность: Списки типов данных

Автор Чижова Юлия

Автор: Чижова Юлия

27.04.2024
1013
Из статьи вы узнаете:

Список типов статусов МЧД

GET/corporate-api/v{version}/enums/poa-status-types

Метод позволяет получить список возможных статусов доверенности.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение статуса в системе

name - наименование статуса

description - описание значения статуса

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/poa-status-types

Ответ:

[
    {
        "value": 1,
        "name": "Created",
        "description": "Дата начала действия доверенности еще не наступила"
    },
    {
        "value": 2,
        "name": "Active",
        "description": "Активна"
    },
    {
        "value": 3,
        "name": "Expired",
        "description": "Истекла"
    },
    {
        "value": 4,
        "name": "Revoked",
        "description": "Отозвана"
    },
    {
        "value": 5,
        "name": "Processing",
        "description": "Ожидание подтверждения"
    },
    {
        "value": 6,
        "name": "Rejected",
        "description": "Отказ в регистрации"
    }
]

Список типов статусов транзакций МЧД

GET/corporate-api/v{version}/enums/transaction-status-types

Метод позволяет получить список возможных статусов транзакций.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение статуса в системе

name - наименование статуса

description - описание значения статуса

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

corporate-api/v1/enums/transaction-status-types

Ответ:

[
    {
        "value": 1,
        "name": "Pending",
        "description": "Отправлено"
    },
    {
        "value": 2,
        "name": "Success",
        "description": "Одобрено"
    },
    {
        "value": 3,
        "name": "Failure",
        "description": "Отказано"
    },
    {
        "value": 3,
        "name": "Failure",
        "description": "Отказано"
    }
]

Список типов доверителя

GET/corporate-api/v{version}/enums/principal-types

Метод позволяет получить список возможных типов доверителей.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение типа в системе

name - наименование доверителя

description - описание значения доверителя

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/principal-types

Ответ:

[
    {
        "value": 1,
        "name": "RusOrganization",
        "description": "Российская организация"
    },
    {
        "value": 2,
        "name": "ForeignOrganization",
        "description": "Иностранная организация"
    },
    {
        "value": 3,
        "name": "PrivatePerson",
        "description": "Физическое лицо"
    },
    {
        "value": 4,
        "name": "IndividualEntrepreneur",
        "description": "Индивидуальный предприниматель"
    }
]

Список типов уполномоченного представителя

GET/corporate-api/v{version}/enums/representative-types

Метод позволяет получить список возможных типов представителей.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение типа в системе

name - наименование представителя

description - описание значения представителя

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/representative-types

Ответ:

  {
        "value": 1,
        "name": "Organization",
        "description": "Юридическое лицо"
    },
    {
        "value": 2,
        "name": "IndividualEntrepreneur",
        "description": "Индивидуальный предприниматель"
    },
    {
        "value": 3,
        "name": "PrivatePerson",
        "description": "Физическое лицо"
    },
    {
        "value": 4,
        "name": "RusOrgBranch",
        "description": "Филиал (обособленное подразделение) юридического лица"
    },
    {
        "value": 5,
        "name": "ForeignOrgBranch",
        "description": "Филиал (аккредитованное представительство) иностранного юридического лица"
    }
]

Список типов пола

GET/corporate-api/v{version}/enums/gender-types

Метод позволяет получить список возможных типов пола.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение типа в системе

name - наименование пола

description - описание значения пола

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/gender-types

Ответ:

[
    {
        "value": 1,
        "name": "Male",
        "description": "Мужской"
    },
    {
        "value": 2,
        "name": "Female",
        "description": "Женский"
    }
] 

Список типов гражданства

GET/corporate-api/v{version}/enums/citizenship-type

Метод позволяет получить список возможных типов гражданства.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение типа в системе

name - наименование типа гражданства

description - описание значения типа гражданства

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/citizenship-type

Ответ:

 [
    {
        "value": 1,
        "name": "Russian",
        "description": "Гражданин Российской Федерации"
    },
    {
        "value": 2,
        "name": "Foreign",
        "description": "Иностранный гражданин"
    },
    {
        "value": 3,
        "name": "Stateless",
        "description": "Лицо без гражданства"
    }
]

Список типов взаимоотношений сторон МЧД

GET/corporate-api/v{version}/enums/poa-relationship-types

Метод позволяет получить список возможных типов взаимоотношений.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение типа в системе

name - наименование типа 

description - описание значения типа

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/poa-relationship-types

Ответ:

  {
        "value": 1,
        "name": "B2B",
        "description": "Взаимоотношения между юридическими лицами (организациями)"
    },
    {
        "value": 2,
        "name": "B2G",
        "description": "Взаимоотношения между юридическими лицами и государством"
    },
    {
        "value": 3,
        "name": "Unified",
        "description": "Доверенность единого формата"
    }
]

Список типов возможности оформления передоверия

GET/corporate-api/v{version}/enums/poa-transfer-types

Метод позволяет получить список возможных типов последующего передоверия доверенности для заполнения параметра transferType при создании доверенности с relationshipType =Unified.

Наименование параметраТип параметраЗначениеДополнительно

version 

string

версия API

Обязательный параметр, необходимо указывать "1"

КодЗначениеДополнительно
200

Success

[
  {
    "value": 0,
    "name": "string",
    "description": "string"
  }
]

Возвращаются данные статуса, содержащие следующие значения:

value - значение типа в системе

name - наименование типа

description - описание значения типа

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/enums/poa-transfer-types

Ответ:

[
    {
        "value": 1,
        "name": "OneTime",
        "description": "Однократное передоверие"
    },
    {
        "value": 2,
        "name": "Never",
        "description": "Без возможности передоверия"
    },
    {
        "value": 3,
        "name": "Multiple",
        "description": "Передоверие возможно с последующим передоверием"
    }
]

Комментарии для сайта Cackle

Хотите разобраться
в сервисах Астрал?

Подробные инструкции,
решения проблем
и ответы на вопросы
в Базе знаний

autohello-finger