POST api/Search/XtPINCodeWordSearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PINCodeWord	string	None.
SearchString	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PINCodeWord": "sample string 1",
  "SearchString": "sample string 2",
  "SessionNum": 3,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 4",
  "StagesURL": "sample string 5"
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

XtPINCodeWordSearchQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of XtPINCodeWordSearchResult	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": [
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "Category": "sample string 3",
      "City": "sample string 4",
      "ContactNum": 1,
      "DevNum": 1,
      "DuressCodeFlag": true,
      "Name": "sample string 5",
      "PhoneList": "sample string 6",
      "PinCodeWord": "sample string 7",
      "SearchString": "sample string 8",
      "SiteCWSeqNum": 1,
      "SiteName": "sample string 9",
      "SiteNum": 1,
      "SiteTypeDescription": "sample string 10",
      "State": "sample string 11",
      "StyleCode": "sample string 12",
      "TransmitterCode": "sample string 13",
      "XmitList": "sample string 14",
      "ZipCode": "sample string 15"
    },
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "Category": "sample string 3",
      "City": "sample string 4",
      "ContactNum": 1,
      "DevNum": 1,
      "DuressCodeFlag": true,
      "Name": "sample string 5",
      "PhoneList": "sample string 6",
      "PinCodeWord": "sample string 7",
      "SearchString": "sample string 8",
      "SiteCWSeqNum": 1,
      "SiteName": "sample string 9",
      "SiteNum": 1,
      "SiteTypeDescription": "sample string 10",
      "State": "sample string 11",
      "StyleCode": "sample string 12",
      "TransmitterCode": "sample string 13",
      "XmitList": "sample string 14",
      "ZipCode": "sample string 15"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<XtPINCodeWordSearchQueryResult 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>
    <XtPINCodeWordSearchResult>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <Category>sample string 3</Category>
      <City>sample string 4</City>
      <ContactNum>1</ContactNum>
      <DevNum>1</DevNum>
      <DuressCodeFlag>true</DuressCodeFlag>
      <Name>sample string 5</Name>
      <PhoneList>sample string 6</PhoneList>
      <PinCodeWord>sample string 7</PinCodeWord>
      <SearchString>sample string 8</SearchString>
      <SiteCWSeqNum>1</SiteCWSeqNum>
      <SiteName>sample string 9</SiteName>
      <SiteNum>1</SiteNum>
      <SiteTypeDescription>sample string 10</SiteTypeDescription>
      <State>sample string 11</State>
      <StyleCode>sample string 12</StyleCode>
      <TransmitterCode>sample string 13</TransmitterCode>
      <XmitList>sample string 14</XmitList>
      <ZipCode>sample string 15</ZipCode>
    </XtPINCodeWordSearchResult>
    <XtPINCodeWordSearchResult>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <Category>sample string 3</Category>
      <City>sample string 4</City>
      <ContactNum>1</ContactNum>
      <DevNum>1</DevNum>
      <DuressCodeFlag>true</DuressCodeFlag>
      <Name>sample string 5</Name>
      <PhoneList>sample string 6</PhoneList>
      <PinCodeWord>sample string 7</PinCodeWord>
      <SearchString>sample string 8</SearchString>
      <SiteCWSeqNum>1</SiteCWSeqNum>
      <SiteName>sample string 9</SiteName>
      <SiteNum>1</SiteNum>
      <SiteTypeDescription>sample string 10</SiteTypeDescription>
      <State>sample string 11</State>
      <StyleCode>sample string 12</StyleCode>
      <TransmitterCode>sample string 13</TransmitterCode>
      <XmitList>sample string 14</XmitList>
      <ZipCode>sample string 15</ZipCode>
    </XtPINCodeWordSearchResult>
  </ResultSet>
</XtPINCodeWordSearchQueryResult>