POST api/Site/ValidatePin

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PIN	string	None.
SiteNum	integer	None.
DevNum	integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PIN": "sample string 1",
  "SiteNum": 1,
  "DevNum": 1,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:

<ValidatePinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 4</StagesURL>
  <ApplicationCode>sample string 3</ApplicationCode>
  <SessionNum>2</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <PIN>sample string 1</PIN>
  <SiteNum>1</SiteNum>
</ValidatePinRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValidatePinQueryResult

Name	Type	Additional information
OutputParameter	ValidatePinOutput	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OutputParameter": {
    "Name": "sample string 1",
    "VerifyAuthority": "sample string 2",
    "ContactNum": 1,
    "CWorPIN": "sample string 3",
    "SiteCWSeqNum": 1,
    "SiteGroupNum": 1,
    "SiteGroupCWSeqNum": 1,
    "ExactMatch": true,
    "NotAuthorizedFlag": true,
    "Comment": "sample string 4"
  },
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<ValidatePinQueryResult 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>
  <OutputParameter>
    <CWorPIN>sample string 3</CWorPIN>
    <Comment>sample string 4</Comment>
    <ContactNum>1</ContactNum>
    <ExactMatch>true</ExactMatch>
    <Name>sample string 1</Name>
    <NotAuthorizedFlag>true</NotAuthorizedFlag>
    <SiteCWSeqNum>1</SiteCWSeqNum>
    <SiteGroupCWSeqNum>1</SiteGroupCWSeqNum>
    <SiteGroupNum>1</SiteGroupNum>
    <VerifyAuthority>sample string 2</VerifyAuthority>
  </OutputParameter>
</ValidatePinQueryResult>