| All Verbs | /service/QueryNonRetailerUsers | ||
|---|---|---|---|
| All Verbs | /service/QuerySubReps | ||
| All Verbs | /service/QueryUsers |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Search | query | string | No | |
| UserNameContains | query | string | No | |
| FullNameContains | query | string | No | |
| EmailContains | query | string | No | |
| DisplayNameContains | query | string | No | |
| PrimaryEmailContains | query | string | No | |
| CompanyNameContains | query | string | No | |
| RetailerIdContains | query | string | No | |
| RoleLookup | query | string | No | |
| rep | query | string | No | |
| UsergroupId | query | string | No | |
| UsergroupAccess | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | string | No | |
| RetailerId | form | string | No | |
| SalesRepId | form | string | No | |
| AspMembershipId | form | Guid | No | |
| Meta | form | Dictionary<string, string> | No | |
| Tags | form | Dictionary<string, HashSet<String>> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Shard | form | string | No | |
| form | string | No | ||
| UserName | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| UserName | form | string | No | |
| form | string | No | ||
| PrimaryEmail | form | string | No | |
| PhoneNumber | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DisplayName | form | string | No | |
| Company | form | string | No | |
| BirthDate | form | DateTime? | No | |
| BirthDateRaw | form | string | No | |
| Address | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Country | form | string | No | |
| Culture | form | string | No | |
| FullName | form | string | No | |
| Gender | form | string | No | |
| Language | form | string | No | |
| MailAddress | form | string | No | |
| Nickname | form | string | No | |
| PostalCode | form | string | No | |
| TimeZone | form | string | No | |
| Salt | form | string | No | |
| PasswordHash | form | string | No | |
| DigestHa1Hash | form | string | No | |
| Roles | form | List<string> | No | |
| Permissions | form | List<string> | No | |
| CreatedDate | form | DateTime | No | |
| ModifiedDate | form | DateTime | No | |
| InvalidLoginAttempts | form | int | No | |
| LastLoginAttempt | form | DateTime? | No | |
| LockedDate | form | DateTime? | No | |
| RecoveryToken | form | string | No | |
| RefId | form | int? | No | |
| RefIdStr | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryNonRetailerUsers HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/xlsx
Content-Type: application/xlsx
Content-Length: length
{"search":"String","userNameContains":"String","fullNameContains":"String","emailContains":"String","displayNameContains":"String","primaryEmailContains":"String","companyNameContains":"String","retailerIdContains":"String","roleLookup":"String","rep":"String","usergroupId":"String","usergroupAccess":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/xlsx
Content-Length: length
{"offset":0,"total":0,"results":[{"address":"String","address2":"String","birthDate":"0001-01-01T00:00:00.0000000Z","city":"String","company":"String","country":"String","createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","culture":"String","displayName":"String","email":"String","firstName":"String","fullName":"String","gender":"String","id":0,"language":"String","lastName":"String","mailAddress":"String","meta":{"String":"String"},"nickname":"String","permissions":["String"],"phoneNumber":"String","postalCode":"String","zip":"String","shard":"String","primaryEmail":"String","refId":0,"refIdStr":"String","roles":["String"],"role":"Administrator","state":"String","timeZone":"String","userName":"String","contactId":"String","retailerId":"String","companyName":"String","salesRepId":"String","consumerId":"String","lastLoginAttempt":"0001-01-01T00:00:00.0000000Z","lockedDate":"0001-01-01T00:00:00.0000000Z","salesRep":{"id":"String","bio":"String","regionId":"String","repGroupId":"String","commissionGroup":"String","phone":"String","manager":"String","address":"String","city":"String","state":"String","zip":"String","country":"String","isActive":false,"active":false,"customerServiceEmailAddress":"String"},"parentRepId":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}