GET api/partner/list

Request Information

URI Parameters

None.

Body Parameters

GetAllPartnersRequest
NameDescriptionTypeAdditional information
AgreementCode

string

None.

AtBeginning

boolean

None.

EMail

string

None.

ExceptId

integer

None.

FullConditions

boolean

None.

FullName

string

None.

IdentificationNumber

string

None.

IsPartnersFieldEnable

boolean

None.

IsSubAgent

boolean

None.

LegalName

string

None.

Name

string

None.

OnlyWithDepartments

boolean

None.

OnlyWithGateCode

Флаг для получения только парнеров с GateCod'ом

boolean

None.

Phone

string

None.

ShowObsolete

boolean

None.

Status

PartnerStatus

None.

Full

boolean

None.

RetrieveMappings

boolean

None.

SelectedId

ID выбранного значения, которое обязательно надо включить в ответ

integer

None.

Mask

маска для отбора

string

None.

Limit

кол-во записей, возвращаемое в ответе

integer

None.

IsExternal

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "AgreementCode": "sample string 1",
  "AtBeginning": true,
  "EMail": "sample string 2",
  "ExceptId": 3,
  "FullConditions": true,
  "FullName": "sample string 5",
  "IdentificationNumber": "sample string 6",
  "IsPartnersFieldEnable": true,
  "IsSubAgent": true,
  "LegalName": "sample string 7",
  "Name": "sample string 8",
  "OnlyWithDepartments": true,
  "OnlyWithGateCode": true,
  "Phone": "sample string 10",
  "ShowObsolete": true,
  "Status": 0,
  "Full": true,
  "RetrieveMappings": true,
  "SelectedId": 1,
  "Mask": "sample string 12",
  "Limit": 1,
  "IsExternal": true
}

application/xml, text/xml

Sample:
<GetAllPartnersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.MasterAgentDictionary.Contract.GetAll">
  <Full>true</Full>
  <IsExternal>true</IsExternal>
  <Limit>1</Limit>
  <Mask>sample string 12</Mask>
  <RetrieveMappings>true</RetrieveMappings>
  <SelectedId>1</SelectedId>
  <AgreementCode>sample string 1</AgreementCode>
  <AtBeginning>true</AtBeginning>
  <EMail>sample string 2</EMail>
  <ExceptId>3</ExceptId>
  <FullConditions>true</FullConditions>
  <FullName>sample string 5</FullName>
  <IdentificationNumber>sample string 6</IdentificationNumber>
  <IsPartnersFieldEnable>true</IsPartnersFieldEnable>
  <IsSubAgent>true</IsSubAgent>
  <LegalName>sample string 7</LegalName>
  <Name>sample string 8</Name>
  <OnlyWithDepartments>true</OnlyWithDepartments>
  <OnlyWithGateCode>true</OnlyWithGateCode>
  <Phone>sample string 10</Phone>
  <ShowObsolete>true</ShowObsolete>
  <Status>NotDefined</Status>
</GetAllPartnersRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetAllPartnersRequest'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />