GET api/User/Get?term={term}&fields={fields}&hash={hash}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
term | string |
Required |
|
fields | SearchFields |
Required |
|
hash | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of UserName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Username | string |
None. |
|
SiteId | integer |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
string |
None. |
||
Access | boolean |
None. |
|
UILang | string |
None. |
|
CurrentLoginDate | date |
None. |
|
LastLoginDate | date |
None. |
|
CurrentLoginIp | string |
None. |
|
LastLoginIp | string |
None. |
|
CreationDate | date |
None. |
|
Address | string |
None. |
|
State | string |
None. |
|
City | string |
None. |
|
Country | string |
None. |
|
Town | string |
None. |
|
StateName | string |
None. |
|
CityName | string |
None. |
|
CountryName | string |
None. |
|
TownName | string |
None. |
|
PostalCode | string |
None. |
|
Phone | string |
None. |
|
Mobile | string |
None. |
|
IdNumber | string |
None. |
|
ProfileId | integer |
None. |
|
PriceListId | integer |
None. |
|
InternalCode | string |
None. |
|
ExternalLoginCode | string |
None. |
|
StreetNumber | string |
None. |
|
AddressLine1 | string |
None. |
|
VendorType | integer |
None. |
|
VendorId | integer |
None. |
|
VendorCode | string |
None. |
|
AddressLine2 | string |
None. |
|
Preferences | Collection of Preference |
None. |
|
AccountInfo | Collection of UserAccountInfo |
None. |
|
HashExpiration | date |
None. |
|
Hash | string |
None. |
|
CompanyId | integer |
None. |
|
Company | Company |
None. |
|
MarketingRegisterEventDate | date |
None. |
|
Subscriber | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "Username": "sample string 2", "SiteId": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "EMail": "sample string 6", "Access": true, "UILang": "sample string 8", "CurrentLoginDate": "2024-05-02T20:33:45.9454735-03:00", "LastLoginDate": "2024-05-02T20:33:45.9454735-03:00", "CurrentLoginIp": "sample string 11", "LastLoginIp": "sample string 12", "CreationDate": "2024-05-02T20:33:45.9454735-03:00", "Address": "sample string 14", "State": "sample string 15", "City": "sample string 16", "Country": "sample string 17", "Town": "sample string 18", "StateName": "sample string 19", "CityName": "sample string 20", "CountryName": "sample string 21", "TownName": "sample string 22", "PostalCode": "sample string 23", "Phone": "sample string 24", "Mobile": "sample string 25", "IdNumber": "sample string 26", "ProfileId": 27, "PriceListId": 28, "InternalCode": "sample string 29", "ExternalLoginCode": "sample string 30", "StreetNumber": "sample string 31", "AddressLine1": "sample string 32", "VendorType": 33, "VendorId": 34, "VendorCode": "sample string 35", "AddressLine2": "sample string 36", "Preferences": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "AccountInfo": [ { "Id": "sample string 1", "CreationDate": "sample string 2", "DueDate": "sample string 3", "Type": "sample string 4", "Data1": "sample string 5", "Data2": "sample string 6", "Data3": "sample string 7", "Ammount": 8.0 }, { "Id": "sample string 1", "CreationDate": "sample string 2", "DueDate": "sample string 3", "Type": "sample string 4", "Data1": "sample string 5", "Data2": "sample string 6", "Data3": "sample string 7", "Ammount": 8.0 } ], "HashExpiration": "2024-05-02T20:33:45.9454735-03:00", "Hash": "sample string 38", "CompanyId": 1, "Company": { "Id": 1, "Name": "sample string 2", "Description": "sample string 3", "SiteId": 4, "Active": true, "Images": [ { "Url": "sample string 1", "ColorId": "sample string 2", "Thumbnail": true }, { "Url": "sample string 1", "ColorId": "sample string 2", "Thumbnail": true } ] }, "MarketingRegisterEventDate": "2024-05-02T20:33:45.9454735-03:00", "Subscriber": "sample string 39" }, { "Id": 1, "Username": "sample string 2", "SiteId": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "EMail": "sample string 6", "Access": true, "UILang": "sample string 8", "CurrentLoginDate": "2024-05-02T20:33:45.9454735-03:00", "LastLoginDate": "2024-05-02T20:33:45.9454735-03:00", "CurrentLoginIp": "sample string 11", "LastLoginIp": "sample string 12", "CreationDate": "2024-05-02T20:33:45.9454735-03:00", "Address": "sample string 14", "State": "sample string 15", "City": "sample string 16", "Country": "sample string 17", "Town": "sample string 18", "StateName": "sample string 19", "CityName": "sample string 20", "CountryName": "sample string 21", "TownName": "sample string 22", "PostalCode": "sample string 23", "Phone": "sample string 24", "Mobile": "sample string 25", "IdNumber": "sample string 26", "ProfileId": 27, "PriceListId": 28, "InternalCode": "sample string 29", "ExternalLoginCode": "sample string 30", "StreetNumber": "sample string 31", "AddressLine1": "sample string 32", "VendorType": 33, "VendorId": 34, "VendorCode": "sample string 35", "AddressLine2": "sample string 36", "Preferences": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "AccountInfo": [ { "Id": "sample string 1", "CreationDate": "sample string 2", "DueDate": "sample string 3", "Type": "sample string 4", "Data1": "sample string 5", "Data2": "sample string 6", "Data3": "sample string 7", "Ammount": 8.0 }, { "Id": "sample string 1", "CreationDate": "sample string 2", "DueDate": "sample string 3", "Type": "sample string 4", "Data1": "sample string 5", "Data2": "sample string 6", "Data3": "sample string 7", "Ammount": 8.0 } ], "HashExpiration": "2024-05-02T20:33:45.9454735-03:00", "Hash": "sample string 38", "CompanyId": 1, "Company": { "Id": 1, "Name": "sample string 2", "Description": "sample string 3", "SiteId": 4, "Active": true, "Images": [ { "Url": "sample string 1", "ColorId": "sample string 2", "Thumbnail": true }, { "Url": "sample string 1", "ColorId": "sample string 2", "Thumbnail": true } ] }, "MarketingRegisterEventDate": "2024-05-02T20:33:45.9454735-03:00", "Subscriber": "sample string 39" } ]
text/xml
Sample:
<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <User> <Access>true</Access> <AccountInfo> <UserAccountInfo> <Ammount>8</Ammount> <CreationDate>sample string 2</CreationDate> <Data1>sample string 5</Data1> <Data2>sample string 6</Data2> <Data3>sample string 7</Data3> <DueDate>sample string 3</DueDate> <Id>sample string 1</Id> <Type>sample string 4</Type> </UserAccountInfo> <UserAccountInfo> <Ammount>8</Ammount> <CreationDate>sample string 2</CreationDate> <Data1>sample string 5</Data1> <Data2>sample string 6</Data2> <Data3>sample string 7</Data3> <DueDate>sample string 3</DueDate> <Id>sample string 1</Id> <Type>sample string 4</Type> </UserAccountInfo> </AccountInfo> <Address>sample string 14</Address> <AddressLine1>sample string 32</AddressLine1> <AddressLine2>sample string 36</AddressLine2> <City>sample string 16</City> <CityName>sample string 20</CityName> <Company xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoLCms.Lib.Communications"> <d3p1:Active>true</d3p1:Active> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:Id>1</d3p1:Id> <d3p1:Images> <Picture> <ColorId>sample string 2</ColorId> <Thumbnail>true</Thumbnail> <Url>sample string 1</Url> </Picture> <Picture> <ColorId>sample string 2</ColorId> <Thumbnail>true</Thumbnail> <Url>sample string 1</Url> </Picture> </d3p1:Images> <d3p1:Name>sample string 2</d3p1:Name> <d3p1:SiteId>4</d3p1:SiteId> </Company> <CompanyId>1</CompanyId> <Country>sample string 17</Country> <CountryName>sample string 21</CountryName> <CreationDate>2024-05-02T20:33:45.9454735-03:00</CreationDate> <CurrentLoginDate>2024-05-02T20:33:45.9454735-03:00</CurrentLoginDate> <CurrentLoginIp>sample string 11</CurrentLoginIp> <EMail>sample string 6</EMail> <ExternalLoginCode>sample string 30</ExternalLoginCode> <FirstName>sample string 4</FirstName> <Hash>sample string 38</Hash> <HashExpiration>2024-05-02T20:33:45.9454735-03:00</HashExpiration> <Id>1</Id> <IdNumber>sample string 26</IdNumber> <InternalCode>sample string 29</InternalCode> <LastLoginDate>2024-05-02T20:33:45.9454735-03:00</LastLoginDate> <LastLoginIp>sample string 12</LastLoginIp> <LastName>sample string 5</LastName> <MarketingRegisterEventDate>2024-05-02T20:33:45.9454735-03:00</MarketingRegisterEventDate> <Mobile>sample string 25</Mobile> <Phone>sample string 24</Phone> <PostalCode>sample string 23</PostalCode> <Preferences xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoLCms.Lib.Communications"> <d3p1:Preference> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Preference> <d3p1:Preference> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Preference> </Preferences> <PriceListId>28</PriceListId> <ProfileId>27</ProfileId> <SiteId>3</SiteId> <State>sample string 15</State> <StateName>sample string 19</StateName> <StreetNumber>sample string 31</StreetNumber> <Subscriber>sample string 39</Subscriber> <Town>sample string 18</Town> <TownName>sample string 22</TownName> <UILang>sample string 8</UILang> <Username>sample string 2</Username> <VendorCode>sample string 35</VendorCode> <VendorId>34</VendorId> <VendorType>33</VendorType> </User> <User> <Access>true</Access> <AccountInfo> <UserAccountInfo> <Ammount>8</Ammount> <CreationDate>sample string 2</CreationDate> <Data1>sample string 5</Data1> <Data2>sample string 6</Data2> <Data3>sample string 7</Data3> <DueDate>sample string 3</DueDate> <Id>sample string 1</Id> <Type>sample string 4</Type> </UserAccountInfo> <UserAccountInfo> <Ammount>8</Ammount> <CreationDate>sample string 2</CreationDate> <Data1>sample string 5</Data1> <Data2>sample string 6</Data2> <Data3>sample string 7</Data3> <DueDate>sample string 3</DueDate> <Id>sample string 1</Id> <Type>sample string 4</Type> </UserAccountInfo> </AccountInfo> <Address>sample string 14</Address> <AddressLine1>sample string 32</AddressLine1> <AddressLine2>sample string 36</AddressLine2> <City>sample string 16</City> <CityName>sample string 20</CityName> <Company xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoLCms.Lib.Communications"> <d3p1:Active>true</d3p1:Active> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:Id>1</d3p1:Id> <d3p1:Images> <Picture> <ColorId>sample string 2</ColorId> <Thumbnail>true</Thumbnail> <Url>sample string 1</Url> </Picture> <Picture> <ColorId>sample string 2</ColorId> <Thumbnail>true</Thumbnail> <Url>sample string 1</Url> </Picture> </d3p1:Images> <d3p1:Name>sample string 2</d3p1:Name> <d3p1:SiteId>4</d3p1:SiteId> </Company> <CompanyId>1</CompanyId> <Country>sample string 17</Country> <CountryName>sample string 21</CountryName> <CreationDate>2024-05-02T20:33:45.9454735-03:00</CreationDate> <CurrentLoginDate>2024-05-02T20:33:45.9454735-03:00</CurrentLoginDate> <CurrentLoginIp>sample string 11</CurrentLoginIp> <EMail>sample string 6</EMail> <ExternalLoginCode>sample string 30</ExternalLoginCode> <FirstName>sample string 4</FirstName> <Hash>sample string 38</Hash> <HashExpiration>2024-05-02T20:33:45.9454735-03:00</HashExpiration> <Id>1</Id> <IdNumber>sample string 26</IdNumber> <InternalCode>sample string 29</InternalCode> <LastLoginDate>2024-05-02T20:33:45.9454735-03:00</LastLoginDate> <LastLoginIp>sample string 12</LastLoginIp> <LastName>sample string 5</LastName> <MarketingRegisterEventDate>2024-05-02T20:33:45.9454735-03:00</MarketingRegisterEventDate> <Mobile>sample string 25</Mobile> <Phone>sample string 24</Phone> <PostalCode>sample string 23</PostalCode> <Preferences xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoLCms.Lib.Communications"> <d3p1:Preference> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Preference> <d3p1:Preference> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Preference> </Preferences> <PriceListId>28</PriceListId> <ProfileId>27</ProfileId> <SiteId>3</SiteId> <State>sample string 15</State> <StateName>sample string 19</StateName> <StreetNumber>sample string 31</StreetNumber> <Subscriber>sample string 39</Subscriber> <Town>sample string 18</Town> <TownName>sample string 22</TownName> <UILang>sample string 8</UILang> <Username>sample string 2</Username> <VendorCode>sample string 35</VendorCode> <VendorId>34</VendorId> <VendorType>33</VendorType> </User> </ArrayOfUser>