A DSL definition of StepWeb API using JSON Schema.
- start (integer) - Starting index to offset results from.
- count (integer) - Maximum number of results to return.
- expand (boolean) -
false(default) returns summary profiles,truereturns complete profiles. - query (object) - Definition of the query. See below for examples.
{
"start": 0,
"count": 10,
"query": {
"entity": "experience",
"criteria": {
"company": "My Corporation",
"start": {
"from": "2014-03-15T16:44:53+01:00"
},
"end": {
"to": "2016-04-08T16:44:53+01:00"
}
}
}
}{
"start": 0,
"count": 10,
"query": {
"entity": "email",
"criteria": {
"exists": true
}
}
}{
"start": 0,
"count": 10,
"query": {
"AND": [
{
"entity": "experience",
"criteria": {
"company": "My Corporation",
"start": {
"from": "2014-03-15T16:44:53+01:00"
},
"end": {
"to": "2016-04-08T16:44:53+01:00"
}
}
},
{
"entity": "education",
"criteria": {
"establishment": "Oxford University"
}
}
]
}
}{
"start": 0,
"count": 10,
"query": {
"OR": [
{
"entity": "experience",
"criteria": {
"company": "My Corporation"
}
},
{
"entity": "experience",
"criteria": {
"company": "ACME"
}
}
]
}
}{
"start": 0,
"count": 10,
"query": {
"OR": [
{
"entity": "experience",
"criteria": {
"company": "My Corporation",
"start": {
"from": "2014-03-15T16:44:53+01:00"
},
"end": {
"to": "2016-04-08T16:44:53+01:00"
}
}
},
{
"AND": [
{
"entity": "experience",
"criteria": {
"company": "ACME"
}
},
{
"entity": "education",
"criteria": {
"establishment": "Oxford University"
}
}
]
}
]
}
}{
"start": 0,
"count": 10,
"query": {
"entity": "experience",
"criteria": {
"company": "My Corporation",
"start": {
"from": "2014-03-15T16:44:53+01:00",
"to": "2014-09-15T16:44:53+01:00"
},
"end": {
"from": "2016-01-08T16:44:53+01:00",
"to": "2016-04-08T16:44:53+01:00"
}
}
}
}