GET api/v1/Quotes/Agents
Retrieves an array of agent available in WIN by login user with sales permission and bases on the following criteria agentName: Agent Name.(Option) networksName: Networks Name or Networks Code.(Option) countryName: Country name or ISO code. Minimum length is 2 characters. (Option) cityName: City name or UN Location code. Minimum length is 2 characters. (optional) type: If type = agents then get agent only, If type = AddressBooks then get addressbook only, If type = null then get agents + addressbooks(option) sortBy: Field to sort on. prepend + or - to indicate ascending or descending. Defalult to +AgentName (optional) context: Action Page : RFQ, Airfreight or Admin (requried) contactType: Contact Type for filter WINID service
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| query |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"AddressBookID": 1,
"MSDBID": 1,
"WinID": 1,
"RegistrationType": {
"TheID": 1,
"KeyIdentifier": "sample string 2",
"KeyValue": "sample string 3",
"KeyDescription": "sample string 4",
"IsDefault": true
},
"AccountNumber": "sample string 2",
"IATACode": "sample string 3",
"AgentName": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"Place": "sample string 7",
"City": "sample string 8",
"CityName": "sample string 9",
"StateProvince": "sample string 10",
"CountryCode": "sample string 11",
"CountryName": "sample string 12",
"ZipCode": "sample string 13",
"Networks": [
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
}
],
"Services": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"Website": "sample string 14",
"Email": "sample string 15",
"Phone": "sample string 16",
"Fax": "sample string 17",
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Controls": {
"MaxRFQ": 1
},
"Stats": {
"Quotes": {
"RFQResponseRatio": 1.1,
"QuoteResponseRatio": 1.1
}
},
"Contact": {
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
},
"Created": null,
"Updated": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
},
"CustomerVisibility": true,
"ExternalRefID": "sample string 19",
"PrintDetails": "sample string 20"
},
{
"AddressBookID": 1,
"MSDBID": 1,
"WinID": 1,
"RegistrationType": {
"TheID": 1,
"KeyIdentifier": "sample string 2",
"KeyValue": "sample string 3",
"KeyDescription": "sample string 4",
"IsDefault": true
},
"AccountNumber": "sample string 2",
"IATACode": "sample string 3",
"AgentName": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"Place": "sample string 7",
"City": "sample string 8",
"CityName": "sample string 9",
"StateProvince": "sample string 10",
"CountryCode": "sample string 11",
"CountryName": "sample string 12",
"ZipCode": "sample string 13",
"Networks": [
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
}
],
"Services": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"Website": "sample string 14",
"Email": "sample string 15",
"Phone": "sample string 16",
"Fax": "sample string 17",
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Controls": {
"MaxRFQ": 1
},
"Stats": {
"Quotes": {
"RFQResponseRatio": 1.1,
"QuoteResponseRatio": 1.1
}
},
"Contact": {
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
},
"Created": null,
"Updated": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
},
"CustomerVisibility": true,
"ExternalRefID": "sample string 19",
"PrintDetails": "sample string 20"
},
{
"AddressBookID": 1,
"MSDBID": 1,
"WinID": 1,
"RegistrationType": {
"TheID": 1,
"KeyIdentifier": "sample string 2",
"KeyValue": "sample string 3",
"KeyDescription": "sample string 4",
"IsDefault": true
},
"AccountNumber": "sample string 2",
"IATACode": "sample string 3",
"AgentName": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"Place": "sample string 7",
"City": "sample string 8",
"CityName": "sample string 9",
"StateProvince": "sample string 10",
"CountryCode": "sample string 11",
"CountryName": "sample string 12",
"ZipCode": "sample string 13",
"Networks": [
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
}
],
"Services": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"Website": "sample string 14",
"Email": "sample string 15",
"Phone": "sample string 16",
"Fax": "sample string 17",
"Location": {
"lat": 1.1,
"lng": 2.1
},
"Controls": {
"MaxRFQ": 1
},
"Stats": {
"Quotes": {
"RFQResponseRatio": 1.1,
"QuoteResponseRatio": 1.1
}
},
"Contact": {
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
},
"Created": null,
"Updated": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
},
"CustomerVisibility": true,
"ExternalRefID": "sample string 19",
"PrintDetails": "sample string 20"
}
]
application/xml, text/xml
Sample:
<ArrayOfAddressBookDTO>
<AddressBookDTO>
<AddressBookID>1</AddressBookID>
<MSDBID>1</MSDBID>
<WinID>1</WinID>
<RegistrationType>
<TheID>1</TheID>
<KeyIdentifier>sample string 2</KeyIdentifier>
<KeyValue>sample string 3</KeyValue>
<KeyDescription>sample string 4</KeyDescription>
<IsDefault>true</IsDefault>
</RegistrationType>
<AccountNumber>sample string 2</AccountNumber>
<IATACode>sample string 3</IATACode>
<AgentName>sample string 4</AgentName>
<Address1>sample string 5</Address1>
<Address2>sample string 6</Address2>
<Place>sample string 7</Place>
<City>sample string 8</City>
<CityName>sample string 9</CityName>
<StateProvince>sample string 10</StateProvince>
<CountryCode>sample string 11</CountryCode>
<CountryName>sample string 12</CountryName>
<ZipCode>sample string 13</ZipCode>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Website>sample string 14</Website>
<Email>sample string 15</Email>
<Phone>sample string 16</Phone>
<Fax>sample string 17</Fax>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
<Controls>
<MaxRFQ>1</MaxRFQ>
</Controls>
<Stats>
<Quotes>
<RFQResponseRatio>1.1</RFQResponseRatio>
<QuoteResponseRatio>1.1</QuoteResponseRatio>
</Quotes>
</Stats>
<Contact>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</Contact>
<Created />
<Updated>
<AgentID>1</AgentID>
<AgentName />
<ContactID>0</ContactID>
<ContactName />
</Updated>
<CustomerVisibility>true</CustomerVisibility>
<ExternalRefID>sample string 19</ExternalRefID>
<PrintDetails>sample string 20</PrintDetails>
</AddressBookDTO>
<AddressBookDTO>
<AddressBookID>1</AddressBookID>
<MSDBID>1</MSDBID>
<WinID>1</WinID>
<RegistrationType>
<TheID>1</TheID>
<KeyIdentifier>sample string 2</KeyIdentifier>
<KeyValue>sample string 3</KeyValue>
<KeyDescription>sample string 4</KeyDescription>
<IsDefault>true</IsDefault>
</RegistrationType>
<AccountNumber>sample string 2</AccountNumber>
<IATACode>sample string 3</IATACode>
<AgentName>sample string 4</AgentName>
<Address1>sample string 5</Address1>
<Address2>sample string 6</Address2>
<Place>sample string 7</Place>
<City>sample string 8</City>
<CityName>sample string 9</CityName>
<StateProvince>sample string 10</StateProvince>
<CountryCode>sample string 11</CountryCode>
<CountryName>sample string 12</CountryName>
<ZipCode>sample string 13</ZipCode>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Website>sample string 14</Website>
<Email>sample string 15</Email>
<Phone>sample string 16</Phone>
<Fax>sample string 17</Fax>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
<Controls>
<MaxRFQ>1</MaxRFQ>
</Controls>
<Stats>
<Quotes>
<RFQResponseRatio>1.1</RFQResponseRatio>
<QuoteResponseRatio>1.1</QuoteResponseRatio>
</Quotes>
</Stats>
<Contact>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</Contact>
<Created />
<Updated>
<AgentID>1</AgentID>
<AgentName />
<ContactID>0</ContactID>
<ContactName />
</Updated>
<CustomerVisibility>true</CustomerVisibility>
<ExternalRefID>sample string 19</ExternalRefID>
<PrintDetails>sample string 20</PrintDetails>
</AddressBookDTO>
<AddressBookDTO>
<AddressBookID>1</AddressBookID>
<MSDBID>1</MSDBID>
<WinID>1</WinID>
<RegistrationType>
<TheID>1</TheID>
<KeyIdentifier>sample string 2</KeyIdentifier>
<KeyValue>sample string 3</KeyValue>
<KeyDescription>sample string 4</KeyDescription>
<IsDefault>true</IsDefault>
</RegistrationType>
<AccountNumber>sample string 2</AccountNumber>
<IATACode>sample string 3</IATACode>
<AgentName>sample string 4</AgentName>
<Address1>sample string 5</Address1>
<Address2>sample string 6</Address2>
<Place>sample string 7</Place>
<City>sample string 8</City>
<CityName>sample string 9</CityName>
<StateProvince>sample string 10</StateProvince>
<CountryCode>sample string 11</CountryCode>
<CountryName>sample string 12</CountryName>
<ZipCode>sample string 13</ZipCode>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Website>sample string 14</Website>
<Email>sample string 15</Email>
<Phone>sample string 16</Phone>
<Fax>sample string 17</Fax>
<Location>
<lat>1.1</lat>
<lng>2.1</lng>
</Location>
<Controls>
<MaxRFQ>1</MaxRFQ>
</Controls>
<Stats>
<Quotes>
<RFQResponseRatio>1.1</RFQResponseRatio>
<QuoteResponseRatio>1.1</QuoteResponseRatio>
</Quotes>
</Stats>
<Contact>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</Contact>
<Created />
<Updated>
<AgentID>1</AgentID>
<AgentName />
<ContactID>0</ContactID>
<ContactName />
</Updated>
<CustomerVisibility>true</CustomerVisibility>
<ExternalRefID>sample string 19</ExternalRefID>
<PrintDetails>sample string 20</PrintDetails>
</AddressBookDTO>
</ArrayOfAddressBookDTO>