Table of Contents

eGain

AI

Tickets URL

https://media.egain.com/support/contact.asp

eGain KW Training

Virtual Assistant

Social Channels

eGain 21

Other

old API Docs

API Dev Portal

API Examples

Test URI

HTTP GET 

https://banana.egain.cloud/system/ws/v11/ss/article/hello

Login URL

HTTP POST 

https://banana.egain.cloud/system/ws/v12/authentication/user/login?forceLogin=yes

With a Content-Type header of 'application/json' and an example body of 

{"userName": myusername,"password": myPassword1}

Unsure if you should be using v12 of API - need to review docs!

Note the response of above should be 204 and the header 'X-egain-session' will be set in the response with a value.

Get Article

HTTP GET with the Header 'X-egain-session' set 

https://banana.egain.cloud/system/ws/v11/ss/article/Prod-2068?portalId=555800000001000&usertype=agent&$attribute=milestone,articleTypeAttributes&workflowMilestone=publish

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:articleResult xmlns="http://bindings.egain.com/ws/model/v3/gen/common" xmlns:ns2="http://bindings.egain.com/ws/model/v3/gen/ss" xmlns:ns4="http://bindings.egain.com/ws/model/v15/gen/kb/profile" xmlns:ns3="http://bindings.egain.com/ws/model/v15/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v15/gen/kb/milestone" xmlns:ns5="http://bindings.egain.com/ws/model/v15/gen/kb/workflow" xmlns:ns8="http://bindings.egain.com/ws/model/v3/gen/gh" xmlns:ns7="http://bindings.egain.com/ws/model/v3/gen/general" xmlns:ns13="http://bindings.egain.com/ws/model/v12/gen/platform" xmlns:ns9="http://bindings.egain.com/ws/model/v3/gen/kb" xmlns:ns12="http://bindings.egain.com/ws/model/v15/gen/kb/tagCategory" xmlns:ns11="http://bindings.egain.com/ws/model/v3/gen/social/community" xmlns:ns10="http://bindings.egain.com/ws/model/v3/gen/meta" xmlns:ns14="http://bindings.egain.com/ws/model/v12/gen/common">
    <callInfo>
        <httpStatus>200</httpStatus>
        <portalId>603800000001000</portalId>
        <resource>article</resource>
        <subResource></subResource>
        <resourceId>603800000002068</resourceId>
        <timestamp>Mon Feb 20 10:05:55 GMT 2023</timestamp>
        <duration>120</duration>
        <status>success</status>
        <wsVersion>11.0</wsVersion>
        <dataVersion>3.0</dataVersion>
        <userType>agent</userType>
    </callInfo>
    <pagingInfo>
        <count>1</count>
        <pageNumber>1</pageNumber>
        <rangeStart>0</rangeStart>
        <rangeSize>1</rangeSize>
        <maxRange>1</maxRange>
    </pagingInfo>
    <deploymentInfo>
        <eGainSecure>true</eGainSecure>
        <spAuthenticationEnabled>false</spAuthenticationEnabled>
    </deploymentInfo>
    <ns2:article alternateId="Prod-2068" id="603800000002068">
        <link rel="self" href="https://banana.egain.cloud/system/ws/v11/ss/article/Prod-2068?$attribute=milestone&amp;workflowMilestone=publish&amp;portalId=555800000001000&amp;usertype=agent&amp;"/>
        <ns2:name>Account Number Required</ns2:name>
        <ns2:content>&lt;p&gt;&lt;span lang="EN" style="font-size:9pt"&gt;&lt;span style="font-family:&amp;#39;arial&amp;#39; , sans-serif"&gt;The Account Number you require is&lt;/span&gt;&lt;/span&gt;&lt;/p&gt;&lt;p style="margin:0cm 0cm 8pt"&gt;&lt;span style="font-size:9pt"&gt;&lt;span style="font-family:&amp;#39;arial&amp;#39; , sans-serif"&gt;&lt;span style="line-height:107%"&gt;We offer a digital self- serve option via our website at &lt;a href="https://myaccount.purplepi.ie/"&gt;&lt;font color="#0563c1"&gt;https://myaccount.purplepi.ie&lt;/font&gt;&lt;/a&gt;&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;/p&gt;&lt;p style="margin:0cm 0cm 8pt"&gt;&lt;span style="font-size:9pt"&gt;&lt;span style="font-family:&amp;#39;arial&amp;#39; , sans-serif"&gt;&lt;span style="line-height:107%"&gt;By registering as a customer and selecting the Find My Account Number option if you update the County with the PI and Serial Number from the PurplePi meter you can search for the Account Number.&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;/p&gt;</ns2:content>
        <ns2:articleType>0</ns2:articleType>
        <ns2:commitState>1</ns2:commitState>
        <ns2:contentType>1</ns2:contentType>
        <ns2:createdBy>1030</ns2:createdBy>
        <ns2:createdByUserName>bob</ns2:createdByUserName>
        <ns2:createdDate>2018-04-19T10:32:36.000+01:00</ns2:createdDate>
        <ns2:departmentId>999</ns2:departmentId>
        <ns2:expiryDateTimeZone>GMT</ns2:expiryDateTimeZone>
        <ns2:hasAttachments>false</ns2:hasAttachments>
        <ns2:isDeleted>false</ns2:isDeleted>
        <ns2:isLocked>false</ns2:isLocked>
        <ns2:isPromoted>false</ns2:isPromoted>
        <ns2:isPublic>true</ns2:isPublic>
        <ns2:languageId>4</ns2:languageId>
        <ns2:lastModifiedBy>1395</ns2:lastModifiedBy>
        <ns2:lastModifiedByUserName>gerry_berry</ns2:lastModifiedByUserName>
        <ns2:lastModifiedDate>2023-01-13T14:53:58.000Z</ns2:lastModifiedDate>
        <ns2:lockedBy>0</ns2:lockedBy>
        <ns2:lockDate>2023-01-13T14:47:07.000Z</ns2:lockDate>
        <ns2:owner>0</ns2:owner>
        <ns2:parentFolderId>603800000002063</ns2:parentFolderId>
        <ns2:parentFolderType>7</ns2:parentFolderType>
        <ns2:snippet></ns2:snippet>
        <ns2:state>P</ns2:state>
        <ns2:topicBreadcrumb>
            <ns2:topic>
                <ns2:id>555800000001004</ns2:id>
                <ns2:name>Purple Pi Enquiries</ns2:name>
            </ns2:topic>
        </ns2:topicBreadcrumb>
        <ns2:uuid>A539D00A-7E4C-4358-8D02-7C6F49B03766</ns2:uuid>
        <ns2:version>3</ns2:version>
        <ns2:versionId>603800000001262</ns2:versionId>
        <ns2:workflow>
            <ns5:stage>
                <ns5:name>publish</ns5:name>
                <ns5:milestone>
                    <ns6:name>
                        <ns6:value>publish</ns6:value>
                        <ns6:displayValue>Published</ns6:displayValue>
                    </ns6:name>
                </ns5:milestone>
            </ns5:stage>
        </ns2:workflow>
    </ns2:article>
</ns2:articleResult>

Knowledge Tips

Analytics

Sample KW Website