TPClientWebServicesAPI

Click here for a complete list of operations.

KBGetDocumentsByKeywords

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /semp/TPClientWebServicesAPI.asmx HTTP/1.1
Host: semp.teleperformance.com.br
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/KBGetDocumentsByKeywords"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <KBGetDocumentsByKeywords xmlns="http://tempuri.org/">
      <PublicKey1>string</PublicKey1>
      <EncryptedUser>string</EncryptedUser>
      <EncryptedPassword>string</EncryptedPassword>
      <EncryptedSignature>string</EncryptedSignature>
      <Language>string</Language>
      <keywords>string</keywords>
      <useAndOperator>boolean</useAndOperator>
    </KBGetDocumentsByKeywords>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <KBGetDocumentsByKeywordsResponse xmlns="http://tempuri.org/">
      <KBGetDocumentsByKeywordsResult>
        <response>
          <responseCode>int</responseCode>
          <responseDescription>string</responseDescription>
          <encryptedSymmetrickey>string</encryptedSymmetrickey>
        </response>
        <Documents>
          <APIKBGetDocumentInfo>
            <idDocument>int</idDocument>
            <CategoriesJSON>string</CategoriesJSON>
            <DocumentType>string</DocumentType>
            <IsPublicDocument>boolean</IsPublicDocument>
            <AverageRating>double</AverageRating>
            <DateRating>dateTime</DateRating>
            <CountRating>int</CountRating>
            <HitsDocument>int</HitsDocument>
            <DateHits>dateTime</DateHits>
            <RelatedDocumentsCount>int</RelatedDocumentsCount>
            <DateIsUseful>dateTime</DateIsUseful>
            <CountIsUseful>int</CountIsUseful>
            <CountIsUsefulYes>int</CountIsUsefulYes>
            <idDocumentLanguage>string</idDocumentLanguage>
            <idLanguage>string</idLanguage>
            <VersionDocumentLanguage>string</VersionDocumentLanguage>
            <NameDocumentlanguage>string</NameDocumentlanguage>
            <SummaryDocumentlanguage>string</SummaryDocumentlanguage>
            <IsActiveDocumentlanguage>boolean</IsActiveDocumentlanguage>
            <KeywordsDocumentlanguage>string</KeywordsDocumentlanguage>
            <URLDocumentlanguage>string</URLDocumentlanguage>
            <TypeDocumentlanguage>string</TypeDocumentlanguage>
            <DateUploadDocumentlanguage>dateTime</DateUploadDocumentlanguage>
            <DateValidSinceDocumentlanguage>dateTime</DateValidSinceDocumentlanguage>
            <DateValidUntilDocumentlanguage>dateTime</DateValidUntilDocumentlanguage>
            <AutoEnableDisableDocumentlanguage>boolean</AutoEnableDisableDocumentlanguage>
            <UploadedByIdUSER>int</UploadedByIdUSER>
            <idCase>int</idCase>
          </APIKBGetDocumentInfo>
          <APIKBGetDocumentInfo>
            <idDocument>int</idDocument>
            <CategoriesJSON>string</CategoriesJSON>
            <DocumentType>string</DocumentType>
            <IsPublicDocument>boolean</IsPublicDocument>
            <AverageRating>double</AverageRating>
            <DateRating>dateTime</DateRating>
            <CountRating>int</CountRating>
            <HitsDocument>int</HitsDocument>
            <DateHits>dateTime</DateHits>
            <RelatedDocumentsCount>int</RelatedDocumentsCount>
            <DateIsUseful>dateTime</DateIsUseful>
            <CountIsUseful>int</CountIsUseful>
            <CountIsUsefulYes>int</CountIsUsefulYes>
            <idDocumentLanguage>string</idDocumentLanguage>
            <idLanguage>string</idLanguage>
            <VersionDocumentLanguage>string</VersionDocumentLanguage>
            <NameDocumentlanguage>string</NameDocumentlanguage>
            <SummaryDocumentlanguage>string</SummaryDocumentlanguage>
            <IsActiveDocumentlanguage>boolean</IsActiveDocumentlanguage>
            <KeywordsDocumentlanguage>string</KeywordsDocumentlanguage>
            <URLDocumentlanguage>string</URLDocumentlanguage>
            <TypeDocumentlanguage>string</TypeDocumentlanguage>
            <DateUploadDocumentlanguage>dateTime</DateUploadDocumentlanguage>
            <DateValidSinceDocumentlanguage>dateTime</DateValidSinceDocumentlanguage>
            <DateValidUntilDocumentlanguage>dateTime</DateValidUntilDocumentlanguage>
            <AutoEnableDisableDocumentlanguage>boolean</AutoEnableDisableDocumentlanguage>
            <UploadedByIdUSER>int</UploadedByIdUSER>
            <idCase>int</idCase>
          </APIKBGetDocumentInfo>
        </Documents>
        <JsonDocuments>string</JsonDocuments>
      </KBGetDocumentsByKeywordsResult>
    </KBGetDocumentsByKeywordsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /semp/TPClientWebServicesAPI.asmx HTTP/1.1
Host: semp.teleperformance.com.br
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <KBGetDocumentsByKeywords xmlns="http://tempuri.org/">
      <PublicKey1>string</PublicKey1>
      <EncryptedUser>string</EncryptedUser>
      <EncryptedPassword>string</EncryptedPassword>
      <EncryptedSignature>string</EncryptedSignature>
      <Language>string</Language>
      <keywords>string</keywords>
      <useAndOperator>boolean</useAndOperator>
    </KBGetDocumentsByKeywords>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <KBGetDocumentsByKeywordsResponse xmlns="http://tempuri.org/">
      <KBGetDocumentsByKeywordsResult>
        <response>
          <responseCode>int</responseCode>
          <responseDescription>string</responseDescription>
          <encryptedSymmetrickey>string</encryptedSymmetrickey>
        </response>
        <Documents>
          <APIKBGetDocumentInfo>
            <idDocument>int</idDocument>
            <CategoriesJSON>string</CategoriesJSON>
            <DocumentType>string</DocumentType>
            <IsPublicDocument>boolean</IsPublicDocument>
            <AverageRating>double</AverageRating>
            <DateRating>dateTime</DateRating>
            <CountRating>int</CountRating>
            <HitsDocument>int</HitsDocument>
            <DateHits>dateTime</DateHits>
            <RelatedDocumentsCount>int</RelatedDocumentsCount>
            <DateIsUseful>dateTime</DateIsUseful>
            <CountIsUseful>int</CountIsUseful>
            <CountIsUsefulYes>int</CountIsUsefulYes>
            <idDocumentLanguage>string</idDocumentLanguage>
            <idLanguage>string</idLanguage>
            <VersionDocumentLanguage>string</VersionDocumentLanguage>
            <NameDocumentlanguage>string</NameDocumentlanguage>
            <SummaryDocumentlanguage>string</SummaryDocumentlanguage>
            <IsActiveDocumentlanguage>boolean</IsActiveDocumentlanguage>
            <KeywordsDocumentlanguage>string</KeywordsDocumentlanguage>
            <URLDocumentlanguage>string</URLDocumentlanguage>
            <TypeDocumentlanguage>string</TypeDocumentlanguage>
            <DateUploadDocumentlanguage>dateTime</DateUploadDocumentlanguage>
            <DateValidSinceDocumentlanguage>dateTime</DateValidSinceDocumentlanguage>
            <DateValidUntilDocumentlanguage>dateTime</DateValidUntilDocumentlanguage>
            <AutoEnableDisableDocumentlanguage>boolean</AutoEnableDisableDocumentlanguage>
            <UploadedByIdUSER>int</UploadedByIdUSER>
            <idCase>int</idCase>
          </APIKBGetDocumentInfo>
          <APIKBGetDocumentInfo>
            <idDocument>int</idDocument>
            <CategoriesJSON>string</CategoriesJSON>
            <DocumentType>string</DocumentType>
            <IsPublicDocument>boolean</IsPublicDocument>
            <AverageRating>double</AverageRating>
            <DateRating>dateTime</DateRating>
            <CountRating>int</CountRating>
            <HitsDocument>int</HitsDocument>
            <DateHits>dateTime</DateHits>
            <RelatedDocumentsCount>int</RelatedDocumentsCount>
            <DateIsUseful>dateTime</DateIsUseful>
            <CountIsUseful>int</CountIsUseful>
            <CountIsUsefulYes>int</CountIsUsefulYes>
            <idDocumentLanguage>string</idDocumentLanguage>
            <idLanguage>string</idLanguage>
            <VersionDocumentLanguage>string</VersionDocumentLanguage>
            <NameDocumentlanguage>string</NameDocumentlanguage>
            <SummaryDocumentlanguage>string</SummaryDocumentlanguage>
            <IsActiveDocumentlanguage>boolean</IsActiveDocumentlanguage>
            <KeywordsDocumentlanguage>string</KeywordsDocumentlanguage>
            <URLDocumentlanguage>string</URLDocumentlanguage>
            <TypeDocumentlanguage>string</TypeDocumentlanguage>
            <DateUploadDocumentlanguage>dateTime</DateUploadDocumentlanguage>
            <DateValidSinceDocumentlanguage>dateTime</DateValidSinceDocumentlanguage>
            <DateValidUntilDocumentlanguage>dateTime</DateValidUntilDocumentlanguage>
            <AutoEnableDisableDocumentlanguage>boolean</AutoEnableDisableDocumentlanguage>
            <UploadedByIdUSER>int</UploadedByIdUSER>
            <idCase>int</idCase>
          </APIKBGetDocumentInfo>
        </Documents>
        <JsonDocuments>string</JsonDocuments>
      </KBGetDocumentsByKeywordsResult>
    </KBGetDocumentsByKeywordsResponse>
  </soap12:Body>
</soap12:Envelope>