POST api/SiteGroup/SiteGroupExternalUserPick
Request Information
URI Parameters
None.
Body Parameters
SiteGroupNumRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteGroupNum | integer |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteGroupNum": 1,
"SessionNum": 1,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 2",
"StagesURL": "sample string 3"
}
application/xml, text/xml
Sample:
<SiteGroupNumRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 3</StagesURL> <ApplicationCode>sample string 2</ApplicationCode> <SessionNum>1</SessionNum> <SessionPassword>QEA=</SessionPassword> <SiteGroupNum>1</SiteGroupNum> </SiteGroupNumRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteGroupExternalUserPickQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of SiteGroupExternalUserPickResult |
None. |
|
| Success | boolean |
None. |
|
| UserErrorMessage | string |
None. |
|
| ErrorTypeNum | integer |
None. |
|
| SqlConnectionLost | boolean |
None. |
|
| ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ExcludeColumnList": [
"sample string 1",
"sample string 2"
],
"ResultSet": [
{
"ContactNum": 1,
"EffectiveDate": "2025-12-14T17:41:21.8410113-05:00",
"ExpireDate": "2025-12-14T17:41:21.8410113-05:00",
"FirstName": "sample string 1",
"KeyNum": 1,
"KeyType": "sample string 2",
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"Name": "sample string 5",
"SeqNum": 1,
"SiteGroupName": "sample string 6",
"SiteGroupNum": 1,
"Suffix": "sample string 7",
"Title": "sample string 8",
"XtAppUserNum": 1
},
{
"ContactNum": 1,
"EffectiveDate": "2025-12-14T17:41:21.8410113-05:00",
"ExpireDate": "2025-12-14T17:41:21.8410113-05:00",
"FirstName": "sample string 1",
"KeyNum": 1,
"KeyType": "sample string 2",
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"Name": "sample string 5",
"SeqNum": 1,
"SiteGroupName": "sample string 6",
"SiteGroupNum": 1,
"Suffix": "sample string 7",
"Title": "sample string 8",
"XtAppUserNum": 1
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<SiteGroupExternalUserPickQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
<ClientVersion>sample string 5</ClientVersion>
<ErrorTypeNum>3</ErrorTypeNum>
<SqlConnectionLost>true</SqlConnectionLost>
<Success>true</Success>
<UserErrorMessage>sample string 2</UserErrorMessage>
<ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ExcludeColumnList>
<ResultSet>
<SiteGroupExternalUserPickResult>
<ContactNum>1</ContactNum>
<EffectiveDate>2025-12-14T17:41:21.8410113-05:00</EffectiveDate>
<ExpireDate>2025-12-14T17:41:21.8410113-05:00</ExpireDate>
<FirstName>sample string 1</FirstName>
<KeyNum>1</KeyNum>
<KeyType>sample string 2</KeyType>
<LastName>sample string 3</LastName>
<MiddleName>sample string 4</MiddleName>
<Name>sample string 5</Name>
<SeqNum>1</SeqNum>
<SiteGroupName>sample string 6</SiteGroupName>
<SiteGroupNum>1</SiteGroupNum>
<Suffix>sample string 7</Suffix>
<Title>sample string 8</Title>
<XtAppUserNum>1</XtAppUserNum>
</SiteGroupExternalUserPickResult>
<SiteGroupExternalUserPickResult>
<ContactNum>1</ContactNum>
<EffectiveDate>2025-12-14T17:41:21.8410113-05:00</EffectiveDate>
<ExpireDate>2025-12-14T17:41:21.8410113-05:00</ExpireDate>
<FirstName>sample string 1</FirstName>
<KeyNum>1</KeyNum>
<KeyType>sample string 2</KeyType>
<LastName>sample string 3</LastName>
<MiddleName>sample string 4</MiddleName>
<Name>sample string 5</Name>
<SeqNum>1</SeqNum>
<SiteGroupName>sample string 6</SiteGroupName>
<SiteGroupNum>1</SiteGroupNum>
<Suffix>sample string 7</Suffix>
<Title>sample string 8</Title>
<XtAppUserNum>1</XtAppUserNum>
</SiteGroupExternalUserPickResult>
</ResultSet>
</SiteGroupExternalUserPickQueryResult>