Описание возможных полей в запросе к веб-сервису SSO

Owned by Виктория
Oct 29, 2024
2 min read

#

Наименование поля

Тип(длина)

Обяз.

Описание

Пример заполнения

1

request

 

0..1

 

 

1.1

SignOutUrl

 xsd:string

 0..1

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

https://site.com

1.2

OuterId

xsd:string

0..1

номер командировки во внутренней клиентской системе, должен быть уникальным

69d55a3f-4dac-4511-b87e-1d2d1187a05e

1.3

CurrentRoute

 

0..1

маршрут и даты командировки для автозаполнения

 

1.3.1

Origin

xsd:string

0..1

название города, из которого совершается командировка

Москва

1.3.2

Destination

xsd:string

0..1

название города, куда совершается командировка

Самара

1.3.3

DepartureDate

xsd:dateTime

1..1

дата начала командировки

2024-07-23T00:00:00

1.3.4

ReturnDate

nillable xsd:dateTime

1..1

дата окончания командироки

2024-07-26T00:00:00

1.4

CustomRoute

 

0..1

Расширенный маршрут – если параметра CurrentRoute недостаточно

 

1.4.1

RoutePart

 

0..n

Описание одного из участков маршрута

 

1.4.1.1

UniqueId

xsd:string

0..1

уникальный идентификатор, передается для определения идентичности двух участков маршрута - как первичный ключ из внешней системы

6e5cc3b1-4c85-4714-860a-c3e046b33a0d

1.4.1.2

DateDepart

xsd:dateTime

1..1

дата отправления/заезда

2024-12-23

1.4.1.3

DateReturn

xsd:dateTime

1..1

дата возвращения/выезда

2024-12-26

1.4.1.4

Origin

xsd:string

0..1

откуда, город

Москва

1.4.1.5

Destination

xsd:string

0..1

куда, город

Санкт-Петербург

1.4.1.6

ServiceType

xsd:string

0..1

тип услуги - transport (транспорт)/lodging (проживание)

transport

1.4.1.7

DepartureAdvanceShiftDays

xsd:int

1..1

начало поездки можно сдвинуть влево на Х дней

1

1.4.1.8

DeparturePostShiftDays

xsd:int

1..1

начало поездки можно сдвинуть вправо на Х дней

1

1.4.1.9

ReturnAdvanceShiftDays

xsd:int

1..1

окончание поездки можно сдвинуть влево на Х дней

1

1.4.1.10

ReturnPostShiftDays

xsd:int

1..1

окончание поездки можно сдвинуть вправо на Х дней

1

1.4.1.11

BookingSequence

xsd:int

1..1

очередность бронирования услуг, сперва нужно забронировать все услуги с меньшей очередностью

0

1.5

CustomOptions

 

0..1

Контейнер для списка дополнительных параметров, которые могут быть использованы для управления процессом

 

1.5.1

CustomOption

 

0..n

Описание одного из дополнительных параметров

 

1.5.1.1

Key

xsd:string

0..1

Ключ (название) параметра

routeControl

1.5.1.2

Value

xsd:string

0..1

Значение параметра

true

1.6

Persons

 

0..1

участники командировки

 

1.6.1

Person

 

0..n

 данные по участнику командировки

 

1.6.1.1

LastName

attribute xsd:string

1..1

фамилия на русском

Аршавин

1.6.1.2

FirstName

attribute xsd:string

1..1

 имя на русском

Андрей

1.6.1.3

MiddleName

attribute xsd:string

1..1

отчество на русском

Сергеевич

1.6.1.4

LastNameLatin

attribute xsd:string

0..1

 фамилия латиницей как в загранпаспорте

Arshavin

1.6.1.5

FirstNameLatin

attribute xsd:string

0..1

имя латиницей как в загранпаспорте

Andrey

1.6.1.6

MiddleNameLatin

attribute xsd:string

0..1

 отчество латиницей как в загранпаспорте

Sergeevich

1.6.1.7

Gender

attribute xsd: string

1..1

пол, true - мужской, false - женский

true

false

1.6.1.8

DateBirth

attribute xsd:dateTime

1..1

 дата рождения

 1986-05-30

1.6.1.9

INN

xsd:string

0..1

ИНН организации-плательщика, от которой едет пассажир

111111111111

1.6.1.10

KPP

xsd:string

0..1

КПП организации-плательщика, от которой едет пассажир

 111111111111

1.6.1.11

CountryAlpha2

xsd:string (2)

0..1

двухбуквенный код ISO гражданства

RU

1.6.1.12

Documents

 

0..1

документы пассажира

 

1.6.1.12.1

Document

xsd:string (2)

0..n

данные документа пассажира

 

1.6.1.12.1.1

CountryCode

attribute xsd:string

1..1

код страны, выдавшей документ

 RU

1.6.1.12.1.2

DocumentNumber

attribute xsd:string

1..1

номер документа

123456789

1.6.1.12.1.3

DocumentType

attribute xsd:string

1..1

тип документа

NationalPassport

1.6.1.12.1.4

DateValid

attribute xsd:string

1..1

срок действия документа

 

1.6.1.13

Contacts

 

0..1

контакты пассажира

 

1.6.1.13.1

Contact

 

0..n

данные о контакте пассажира

 

1.6.1.13.1.1

ContactType

attribute xsd:string

1..1

тип контакта

Email

1.6.1.13.1.2

Value

attribute xsd:string

1..1

значение контакта

mailto@user.mail

1.6.1.14

PersonalCodes

 

0..1

список структурных кодов, привязанных к персоне

 

1.6.1.14.1

Code

 

0..n

данные по одному структурнму коду, привязанному к персоне

 

1.6.1.14.1.1

DictionaryName

xsd:string

1..1

 название справочника структурных кодов

Табельный номер

1.6.1.14.1.2

CodeValue

xsd:string

1..1

значение кода

00003

1.6.1.14.1.3

IsPrimaryKey

xsd:boolean

1..1

признак того, что код является уникальным ключом персоны (например, табельный номер)

true

false

1.7

BudgetCodes

 

0..1

бюджетные коды, прикрепляемые к командировке

 

1.7.1

BudgetCode

 

0..n

данные по одному из бюджетных кодов, прикрепляемых к командировке

 

1.7.1.1

DictionaryName

xsd:string

0..1

название справочника бюджетного кода

Кост-центр

1.7.1.2

CodeValue

xsd:string

0..1

значение кода

 MOW

1.7.1.3

SelectorState

xsd:string

1..1

признак, указывающий возможность менять код перед отправкой командировки на согласование

Disabled

Enabled

1.8

AccountDetails

 

0..1

данные для авторизации пользователя-создателя командировки внутренней клиентской системы

 

1.8.1

id_Group

attribute xsd:int

1..1

идентификатор группы пользователя в системе

123

1.8.2

GroupSecurityKey

attribute xsd:string

1..1

ключ безопасности для определения валидности группы - сравнивается с ключом в настройках группы

111CC120-D90B-4926-A631-D7AEBC768B6A

1.8.3

Email

attribute xsd:string

1..1

электронная почта пользователя, используемая, как часть составного первичного ключа

user_initiator@fakemail.com

1.8.4

PersonToCreate

 

0..1

Данные о персоне, привязанной к пользователю

 

1.8.4.1

LastName

attribute xsd:string

1..1

фамилия на русском

Аршавин

1.8.4.2

FirstName

attribute xsd:string

1..1

 имя на русском

Андрей

1.8.4.3

MiddleName

attribute xsd:string

1..1

отчество на русском

Сергеевич

1.8.4.4

LastNameLatin

attribute xsd:string

1..1

фамилия латиницей как в загранпаспорте

Arshavin

1.8.4.5

FirstNameLatin

attribute xsd:string

1..1

имя латиницей как в загранпаспорте

Andrey

1.8.4.6

MiddleNameLatin

attribute xsd:string

1..1

 отчество латиницей как в загранпаспорте

Sergeevich

1.8.4.7

Gender

attribute xsd: string

1..1

пол, true - мужской, false - женский

true

false

1.8.4.8

DateBirth

attribute xsd:dateTime

1..1

 дата рождения

 1986-05-30

1.8.4.9

INN

xsd:string

0..1

ИНН организации-плательщика, от которой едет пассажио

111111111111

1.8.4.10

KPP

xsd:string

0..1

КПП организации-плательщика, от которой едет пассажио

 111111111111

1.8.4.11

CountryAlpha2

xsd:string (2)

0..1

двухбуквенный код ISO гражданства

RU

1.8.4.12

Documents

 

0..1

 документы пассажира

 

1.8.4.12.1

Document

xsd:string (2)

0..n

данные документа пассажира

 

1.8.4.12.1.1

CountryCode

attribute xsd:string

1..1

 код страны, выдавшей документ

 RU

1.8.4.12.1.2

DocumentNumber

attribute xsd:string

1..1

номер документа

123456789

1.8.4.12.1.3

DocumentType

attribute xsd:string

1..1

тип документа

NationalPassport

1.8.4.12.1.4

DateValid

attribute xsd:string

1..1

 срок действия документа

 

1.8.4.13

Contacts

 

0..1

контакты пассажира

 

1.8.4.13.1

Contact

 

0..n

 данные о контакте пассажира

 

1.8.4.13.1.1

ContactType

attribute xsd:string

1..1

тип контакта

Email

1.8.4.13.1.2

Value

attribute xsd:string

1..1

 значение контакта

mailto@user.mail

1.8.4.14

PersonalCodes

 

0..1

список структурных кодов, привязанных к персоне

 

1.8.4.14.1

Code

 

0..n

данные по одному структурнму коду, привязанному к персоне

 

1.8.4.14.1.1

DictionaryName

xsd:string

1..1

 название справочника структурных кодов

 Табельный номер

1.8.4.14.1.2

CodeValue

xsd:string

1..1

значение кода

00003

1.8.4.14.1.3

IsPrimaryKey

xsd:boolean

1..1

признак того, что код является уникальным ключом персоны (например, табельный номер)

true

false

1.8.5

id_Role

xsd:int

1..1

Идентификатор роли пользователя в системе

3