GET GetUsers?SID={SID}&bForceFresh={bForceFresh}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SID | integer |
Required |
|
bForceFresh | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
ResponseOfListOfUserModelName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
Status | boolean |
None. |
|
Body | Collection of UserModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Message": "sample string 1", "Status": true, "Body": [ { "UserID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "LoginName": "sample string 4", "Email": "sample string 5", "PGHReportEmail": true, "PGHAccess": true, "PGHAccessText": "sample string 6", "PGHReportEmailText": "sample string 7", "UserRoleID": 8, "UserRoleText": "sample string 9", "CreatedBy": 10, "SID": 11, "IsDeleted": true }, { "UserID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "LoginName": "sample string 4", "Email": "sample string 5", "PGHReportEmail": true, "PGHAccess": true, "PGHAccessText": "sample string 6", "PGHReportEmailText": "sample string 7", "UserRoleID": 8, "UserRoleText": "sample string 9", "CreatedBy": 10, "SID": 11, "IsDeleted": true } ] }
text/html
Sample:
{"Message":"sample string 1","Status":true,"Body":[{"UserID":1,"FirstName":"sample string 2","LastName":"sample string 3","LoginName":"sample string 4","Email":"sample string 5","PGHReportEmail":true,"PGHAccess":true,"PGHAccessText":"sample string 6","PGHReportEmailText":"sample string 7","UserRoleID":8,"UserRoleText":"sample string 9","CreatedBy":10,"SID":11,"IsDeleted":true},{"UserID":1,"FirstName":"sample string 2","LastName":"sample string 3","LoginName":"sample string 4","Email":"sample string 5","PGHReportEmail":true,"PGHAccess":true,"PGHAccessText":"sample string 6","PGHReportEmailText":"sample string 7","UserRoleID":8,"UserRoleText":"sample string 9","CreatedBy":10,"SID":11,"IsDeleted":true}]}
application/xml, text/xml
Sample:
<ResponseOfArrayOfUserModelQpuJTOqg xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common"> <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.UserRole"> <d2p1:UserModel> <d2p1:CreatedBy>10</d2p1:CreatedBy> <d2p1:Email>sample string 5</d2p1:Email> <d2p1:FirstName>sample string 2</d2p1:FirstName> <d2p1:IsDeleted>true</d2p1:IsDeleted> <d2p1:LastName>sample string 3</d2p1:LastName> <d2p1:LoginName>sample string 4</d2p1:LoginName> <d2p1:PGHAccess>true</d2p1:PGHAccess> <d2p1:PGHAccessText>sample string 6</d2p1:PGHAccessText> <d2p1:PGHReportEmail>true</d2p1:PGHReportEmail> <d2p1:PGHReportEmailText>sample string 7</d2p1:PGHReportEmailText> <d2p1:SID>11</d2p1:SID> <d2p1:UserID>1</d2p1:UserID> <d2p1:UserRoleID>8</d2p1:UserRoleID> <d2p1:UserRoleText>sample string 9</d2p1:UserRoleText> </d2p1:UserModel> <d2p1:UserModel> <d2p1:CreatedBy>10</d2p1:CreatedBy> <d2p1:Email>sample string 5</d2p1:Email> <d2p1:FirstName>sample string 2</d2p1:FirstName> <d2p1:IsDeleted>true</d2p1:IsDeleted> <d2p1:LastName>sample string 3</d2p1:LastName> <d2p1:LoginName>sample string 4</d2p1:LoginName> <d2p1:PGHAccess>true</d2p1:PGHAccess> <d2p1:PGHAccessText>sample string 6</d2p1:PGHAccessText> <d2p1:PGHReportEmail>true</d2p1:PGHReportEmail> <d2p1:PGHReportEmailText>sample string 7</d2p1:PGHReportEmailText> <d2p1:SID>11</d2p1:SID> <d2p1:UserID>1</d2p1:UserID> <d2p1:UserRoleID>8</d2p1:UserRoleID> <d2p1:UserRoleText>sample string 9</d2p1:UserRoleText> </d2p1:UserModel> </Body> <Message>sample string 1</Message> <Status>true</Status> </ResponseOfArrayOfUserModelQpuJTOqg>