Endpoint Examples

/resume/getdocids

Retrieves registered resume document IDs from a vendor.

GET /searchservice/resume/getdocids

Headers

NameTypeDescription
acceptstring, enumGenerated from available response content types.
Allowed: application/json (default) and application/xml

Query Parameters

NameTypeDescription
lastDocIdstringTo get the next set of document ids, the lastDocId parameter is used. Supply the last doc id from the previous result to get doc ids after it.
This parameter is optional.
vendorstringVendor name (max length : 50).If vendor name provided then document will be unregistered in specific vendor.
This parameter is optional.
localeenumLocale of the instance (en_us).
This parameter is required.
instanceTypeenumInstance type to be used to search (LENSSEARCH or SPECTRUM).
This parameter is required.
countstringThe maximum number of document ids to be returned in the response.
The default count is 10000.
This parameter is optional.

Code Examples

curl --request GET \
  --url "https://lensapi.burning-glass.com/v2.0/searchservice/resume/getdocids?instanceType=spectrum&locale=en_us&count=100&vendor=sampledemovendor&lastDocId=347953" \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json"
curl --request GET \
  --url "https://lensapi.burning-glass.com/v2.0/searchservice/resume/getdocids?instanceType=spectrum&locale=en_us&count=100&vendor=sampledemovendor&lastDocId=347953" \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/xml" \
  --header "Content-Type: application/xml"

Response Examples

{
  "status": true,
  "statusCode": "OK",
  "requestId": "e790c03b-34ba-4e99-8b07-e0600734a518",
  "timeStamp": "2021-12-16 00:48:29.645",
  "responseData": {
    "vendorName": "jobsrus",
    "locale": "en_us",
    "instanceType": "SPECTRUM",
    "resultsCount": 50,
    "lastdocid": "USA_ENG_11208",
    "getdocids": {
      "id": [
        "USA_ENG_11159",
        "USA_ENG_11160",
        "USA_ENG_11161",
        "USA_ENG_11162",
        "USA_ENG_11163",
        "USA_ENG_11164",
        "USA_ENG_11165",
        "USA_ENG_11166",
        "USA_ENG_11167",
        "USA_ENG_11168",
        "USA_ENG_11169",
        "USA_ENG_11170",
        "USA_ENG_11171",
        "USA_ENG_11172",
        "USA_ENG_11173",
        "USA_ENG_11174",
        "USA_ENG_11175",
        "USA_ENG_11176",
        "USA_ENG_11177",
        "USA_ENG_11178",
        "USA_ENG_11179",
        "USA_ENG_11180",
        "USA_ENG_11181",
        "USA_ENG_11182",
        "USA_ENG_11183",
        "USA_ENG_11184",
        "USA_ENG_11185",
        "USA_ENG_11186",
        "USA_ENG_11187",
        "USA_ENG_11188",
        "USA_ENG_11189",
        "USA_ENG_11190",
        "USA_ENG_11191",
        "USA_ENG_11192",
        "USA_ENG_11193",
        "USA_ENG_11194",
        "USA_ENG_11195",
        "USA_ENG_11196",
        "USA_ENG_11197",
        "USA_ENG_11198",
        "USA_ENG_11199",
        "USA_ENG_11200",
        "USA_ENG_11201",
        "USA_ENG_11202",
        "USA_ENG_11203",
        "USA_ENG_11204",
        "USA_ENG_11205",
        "USA_ENG_11206",
        "USA_ENG_11207",
        "USA_ENG_11208"
      ]
    },
    "totalFound": 1411
  }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetResumeDocIdsResponse>
    <Status>true</Status>
    <StatusCode>OK</StatusCode>
    <RequestId>a5c54efe-e443-4a9f-8f56-3072d7ea5e01</RequestId>
    <ResponseData>
        <VendorName>jobsrus</VendorName>
        <Locale>en_us</Locale>
        <InstanceType>SPECTRUM</InstanceType>
        <ResultsCount>50</ResultsCount>
        <Lastdocid>USA_ENG_11208</Lastdocid>
        <Getdocids>
            <id>USA_ENG_11159</id>
            <id>USA_ENG_11160</id>
            <id>USA_ENG_11161</id>
            <id>USA_ENG_11162</id>
            <id>USA_ENG_11163</id>
            <id>USA_ENG_11164</id>
            <id>USA_ENG_11165</id>
            <id>USA_ENG_11166</id>
            <id>USA_ENG_11167</id>
            <id>USA_ENG_11168</id>
            <id>USA_ENG_11169</id>
            <id>USA_ENG_11170</id>
            <id>USA_ENG_11171</id>
            <id>USA_ENG_11172</id>
            <id>USA_ENG_11173</id>
            <id>USA_ENG_11174</id>
            <id>USA_ENG_11175</id>
            <id>USA_ENG_11176</id>
            <id>USA_ENG_11177</id>
            <id>USA_ENG_11178</id>
            <id>USA_ENG_11179</id>
            <id>USA_ENG_11180</id>
            <id>USA_ENG_11181</id>
            <id>USA_ENG_11182</id>
            <id>USA_ENG_11183</id>
            <id>USA_ENG_11184</id>
            <id>USA_ENG_11185</id>
            <id>USA_ENG_11186</id>
            <id>USA_ENG_11187</id>
            <id>USA_ENG_11188</id>
            <id>USA_ENG_11189</id>
            <id>USA_ENG_11190</id>
            <id>USA_ENG_11191</id>
            <id>USA_ENG_11192</id>
            <id>USA_ENG_11193</id>
            <id>USA_ENG_11194</id>
            <id>USA_ENG_11195</id>
            <id>USA_ENG_11196</id>
            <id>USA_ENG_11197</id>
            <id>USA_ENG_11198</id>
            <id>USA_ENG_11199</id>
            <id>USA_ENG_11200</id>
            <id>USA_ENG_11201</id>
            <id>USA_ENG_11202</id>
            <id>USA_ENG_11203</id>
            <id>USA_ENG_11204</id>
            <id>USA_ENG_11205</id>
            <id>USA_ENG_11206</id>
            <id>USA_ENG_11207</id>
            <id>USA_ENG_11208</id>
        </Getdocids>
        <TotalFound>1411</TotalFound>
    </ResponseData>
    <TimeStamp>2021-12-16 00:47:50.659</TimeStamp>
</GetResumeDocIdsResponse>