GET api/v1/users/overview

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of UserOverview

Name	Type	Additional information
UserId	globally unique identifier	None.
FriendlyName	string	None.
NotificationEmail	string	None.
PersonName	string	None.
UserName	string	None.
UserRoles	string	None.
ClubName	string	None.
AccountState	string	None.
Id	globally unique identifier	None.
CanUpdateRecord	boolean	None.
CanDeleteRecord	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserId": "66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1",
    "FriendlyName": "sample string 2",
    "NotificationEmail": "sample string 3",
    "PersonName": "sample string 4",
    "UserName": "sample string 5",
    "UserRoles": "sample string 6",
    "ClubName": "sample string 7",
    "AccountState": "sample string 8",
    "Id": "66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1",
    "CanUpdateRecord": true,
    "CanDeleteRecord": true
  },
  {
    "UserId": "66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1",
    "FriendlyName": "sample string 2",
    "NotificationEmail": "sample string 3",
    "PersonName": "sample string 4",
    "UserName": "sample string 5",
    "UserRoles": "sample string 6",
    "ClubName": "sample string 7",
    "AccountState": "sample string 8",
    "Id": "66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1",
    "CanUpdateRecord": true,
    "CanDeleteRecord": true
  }
]

text/html

Sample:

[{"UserId":"66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1","FriendlyName":"sample string 2","NotificationEmail":"sample string 3","PersonName":"sample string 4","UserName":"sample string 5","UserRoles":"sample string 6","ClubName":"sample string 7","AccountState":"sample string 8","Id":"66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1","CanUpdateRecord":true,"CanDeleteRecord":true},{"UserId":"66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1","FriendlyName":"sample string 2","NotificationEmail":"sample string 3","PersonName":"sample string 4","UserName":"sample string 5","UserRoles":"sample string 6","ClubName":"sample string 7","AccountState":"sample string 8","Id":"66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1","CanUpdateRecord":true,"CanDeleteRecord":true}]

application/xml, text/xml

Sample:

<ArrayOfUserOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
  <UserOverview>
    <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
    <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
    <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1</Id>
    <AccountState>sample string 8</AccountState>
    <ClubName>sample string 7</ClubName>
    <FriendlyName>sample string 2</FriendlyName>
    <NotificationEmail>sample string 3</NotificationEmail>
    <PersonName>sample string 4</PersonName>
    <UserId>66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1</UserId>
    <UserName>sample string 5</UserName>
    <UserRoles>sample string 6</UserRoles>
  </UserOverview>
  <UserOverview>
    <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
    <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
    <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1</Id>
    <AccountState>sample string 8</AccountState>
    <ClubName>sample string 7</ClubName>
    <FriendlyName>sample string 2</FriendlyName>
    <NotificationEmail>sample string 3</NotificationEmail>
    <PersonName>sample string 4</PersonName>
    <UserId>66d4ecf3-4dd3-4cfd-bcac-8392c19ebad1</UserId>
    <UserName>sample string 5</UserName>
    <UserRoles>sample string 6</UserRoles>
  </UserOverview>
</ArrayOfUserOverview>