POST api/Site/SiteCodeWordPinVerify
Request Information
URI Parameters
None.
Body Parameters
SiteCodeWordPinVerifyRequestName | Description | Type | Additional information |
---|---|---|---|
CWorPIN | string |
None. |
|
SiteNum | integer |
None. |
|
DevNum | integer |
None. |
|
SeqNum | integer |
None. |
|
ActionPlanFlag | boolean |
None. |
|
CallListName | string |
None. |
|
Comment | string |
None. |
|
PartialMatch | boolean |
None. |
|
ExactMatch | boolean |
None. |
|
ScriptedFlag | boolean |
None. |
|
PhoneCodeWordFlag | boolean |
None. |
|
Phone | string |
None. |
|
PhoneType | string |
None. |
|
DialDescription | string |
None. |
|
ContactNum | integer |
None. |
|
SiteGroupNum | integer |
None. |
|
SiteGroupCWSeqNum | integer |
None. |
|
PIN | string |
None. |
|
NotAuthorizedFlag | boolean |
None. |
|
Name | string |
None. |
|
InvalidPIN | string |
None. |
|
PhoneKeyNum | integer |
None. |
|
PhoneKeyType | string |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CWorPIN": "sample string 1", "SiteNum": 1, "DevNum": 1, "SeqNum": 1, "ActionPlanFlag": true, "CallListName": "sample string 2", "Comment": "sample string 3", "PartialMatch": true, "ExactMatch": true, "ScriptedFlag": true, "PhoneCodeWordFlag": true, "Phone": "sample string 4", "PhoneType": "sample string 5", "DialDescription": "sample string 6", "ContactNum": 1, "SiteGroupNum": 1, "SiteGroupCWSeqNum": 1, "PIN": "sample string 7", "NotAuthorizedFlag": true, "Name": "sample string 8", "InvalidPIN": "sample string 9", "PhoneKeyNum": 1, "PhoneKeyType": "sample string 10", "SessionNum": 11, "SessionPassword": "QEA=", "ApplicationCode": "sample string 12", "StagesURL": "sample string 13" }
application/xml, text/xml
Sample:
<SiteCodeWordPinVerifyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 13</StagesURL> <ApplicationCode>sample string 12</ApplicationCode> <SessionNum>11</SessionNum> <SessionPassword>QEA=</SessionPassword> <ActionPlanFlag>true</ActionPlanFlag> <CWorPIN>sample string 1</CWorPIN> <CallListName>sample string 2</CallListName> <Comment>sample string 3</Comment> <ContactNum>1</ContactNum> <DevNum>1</DevNum> <DialDescription>sample string 6</DialDescription> <ExactMatch>true</ExactMatch> <InvalidPIN>sample string 9</InvalidPIN> <Name>sample string 8</Name> <NotAuthorizedFlag>true</NotAuthorizedFlag> <PIN>sample string 7</PIN> <PartialMatch>true</PartialMatch> <Phone>sample string 4</Phone> <PhoneCodeWordFlag>true</PhoneCodeWordFlag> <PhoneKeyNum>1</PhoneKeyNum> <PhoneKeyType>sample string 10</PhoneKeyType> <PhoneType>sample string 5</PhoneType> <ScriptedFlag>true</ScriptedFlag> <SeqNum>1</SeqNum> <SiteGroupCWSeqNum>1</SiteGroupCWSeqNum> <SiteGroupNum>1</SiteGroupNum> <SiteNum>1</SiteNum> </SiteCodeWordPinVerifyRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteCodeWordPinVerifyQueryResultName | Description | Type | Additional information |
---|---|---|---|
Success | boolean |
None. |
|
UserErrorMessage | string |
None. |
|
ErrorTypeNum | integer |
None. |
|
SqlConnectionLost | boolean |
None. |
|
ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<SiteCodeWordPinVerifyQueryResult 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> </SiteCodeWordPinVerifyQueryResult>