textsearch developers api documentaion
 Table
POST
DELETE
 Fields
POST
DELETE
 Data
POST
 Search
LIST
 Alerts
POST
DELETE
LIST

POST Create New Table
https://textsearch.ze.io/api/public/fields/table-adding.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
tableNametext
Unique table name
Response
200: OK
{
  "status":"OK"
 ,"projectId":"xxx"
  ,"tableName":"users"
}
JSON
 


POST Delete Table
https://textsearch.ze.io/api/public/fields/table-deleting.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
tableNametext
tableName
Response
200: OK
{
  "status":"OK"
 ,"projectId":"xxx"
  ,"tableName":"users"
}
JSON
 


POST Create New Field
https://textsearch.ze.io/api/public/fields/field-adding.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
tableName
required
text

fieldName 
required
text

Response
200: OK
{
  "status":"OK"
 ,"projectId":"xxx"
  ,"tableName":"users"
  ,"fieldName":"xxxxx"
}
JSON
 


POST Delete Field
https://textsearch.ze.io/api/public/fields/field-deleting.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
tableName
required
text

fieldName 
required
text

Response
200: OK
{
  "status":"OK"
}
JSON
 


GETDelete Field
https://textsearch.ze.io/api/console/fields/fieldsToUpdate.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
fieldsParams
required
JSON
{
  projectName:"projectName",
  "data":[
  {
   fieldName:"שם השדה לעדכון" ,
   tableName:"שם הטבלה לעדכון",
   objectId :"מפתח של האובייקט",
   identityId:"מפתח של הטבלה המתעדכנת" ,
   fieldContent :"הערך הטקסטואלי לעדכון" ,
   toDelete :"[סימון y במקרה של מחיקת רשומה]" ,
   rankGroup:"דירוג מ1-5"
  }
  ]
}
Response
200: OK
{
  "status":"OK"
  ,"projectName":"xxx"
  ,"updated":
   [{
       "tableName":"xxx"
       ,"fieldName":"xxx"
       ,"object1Id":"xxx"
       ,"identityId":"xxx"
       ,"errText":null
   }
  ]
}
JSON
 

GETSearch Text
https://textsearch.ze.io/api/public/search.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
searchParams
required
JSON
serachParams [JSON]
 • projectName [שם פרוייקט]
 • onlyCounter [האם להחזיר רק כמות תוצאות שנמצאו ללא רשימה]
 • rowStart [מתחיל בשורה]
 • rowLength [כמות שורות]
 • andWords [כל המילים]
 • orWords [לפחות אחת המילים]  יש להפריד בין המילים באמצעות תו פסיק תו רווח יבצע פעולת וגם.
 • notWords [ללא אחת המילים]
 • ranking [תיעדוף]
 • fields [מאפייני החיפוש]
   ◦ tableName [שם הטבלה לעדכון]
   ◦ fieldName [שם השדה לעדכון]
   ◦ words [המילים לחיפוש]
 • rankingBygroup [האם לתעדף לפי ניקוד קבוצה]
 • sortFieldName [שדה למיון]
 • sortFieldType [סוג מיון: ASC/DESC]
 • groupFieldName [שדה לקיבוץ]


Example Json:
{
  "projectName":"Project 1",
  "rowStart":"0",
  "rowLength":"1000",
  "groupFieldName":"jobLocation",
  "andWords":[
      {
      "fields":[
        {
          "tableName":"*",
          "fieldName":""
        }
      ]
      ,"words":"Manager"
      }
      ,{
      "fields":[
        {
          "tableName":"experience",
          "fieldName":"*"
        }
      ]
      ,"words":"Web Developer"
      }
      ,{
      "fields":[
        {
          "tableName":"experience",
          "fieldName":"notes"
        }
        ,{
          "tableName":"degree",
          "fieldName":"notes"
        }
      ]
      ,"words":"PHP ASP"
      }
  ]
  ,"orWords":[
      {
      "fields":[
        {
          "tableName":"skills",
          "fieldName":"*"
        }
      ]
      ,"words":"Javascript,css html,java"
      }
  ]
  ,"notWords":[
      {
      "fields":[
        {
          "tableName":"experience",
          "fieldName":"company"
        }
      ]
      ,"words":"alljobs drushim"
      }
  ]
  ,"ranking":[
      {
      "fields":[
        {
          "tableName":"userDetails",
          "fieldName":"firstName"
        },
        {
          "tableName":"userDetails",
          "fieldName":"lastName"
        }
      ],
      "fields":[
        {
          "tableName":"korotExperiece",
          "fieldName":"duty"
        },
        {
          "tableName":"korotExperiece",
          "fieldName":"company"
        }
      ]
      }
  ]
  ,"rankingBygroup":false
}


Response
200: OK
{
  "status":"OK"
  ,"count":12
  ,"objects":[
    {
      "objectId":"564285"
    }
    ,{
      "objectId":"386452"
    }
  ]
}

JSON
 

GETCreate New Alert
https://textsearch.ze.io/api/public/alerts/alert-inserting.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
serachParams
JSON
 • companyId [מספר החברה]
 • projectName [שם הפרוייקט]
 • searchId [מספר מזהה של החיפוש]
 • andWords [כל המילים]
 • orWords [לפחות אחת המילים]
 • notWords [ללא אחת המילים]
 • ranking [תיעדוף]
 • fields [מאפייני החיפוש]
   ◦ tableName [שם הטבלה לעדכון]
   ◦ fieldName [שם השדה לעדכון]
   ◦ words [המילים לחיפוש]
Response
200: OK
{
"status":"OK"
   ,"totalTime":xxx
   ,"count":xxx
}
JSON
 


GETDelete Table
https://textsearch.ze.io/api/public/alerts/alert-deleting.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
serachParamsJSON
serachParams [JSON]
 • companyId [מספר החברה]
 • projectName [שם הפרוייקט]
 • serialWatch [קוד הרשאת צפייה ברמת פרוייקט]
 • serialUpdate [קוד הרשאת עדכון ברמת חברה]
 • searchId [מספר מזהה של החיפוש]
Response
200: OK
{
"status":"OK"
   ,"totalTime":xxx
   ,"count":xxx
}
JSON
 


GETDelete Table
https://textsearch.ze.io/api/public/alerts/alert-list.api.asp
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
serachParamsJSON
• companyId [מספר החברה]
 • projectName [שם הפרוייקט]
 • serialWatch [קוד הרשאת צפייה ברמת פרוייקט]
 • rowStart [מתחיל בשורה]
 • rowLength [כמות שורות]
 • searchId [מספר מזהה של החיפוש]
Response
200: OK
{
"status":"OK"
   ,"totalTime":xxx
   ,"count":xxx
   ,"objects":[
     {"rowIndex":1
     ,"objectId":xxxxx
     }
..
}
JSON
 

ze.io