Endpoint Examples

/searchservice

This resource retrieves vendor details based on the passed criteria.

GET /searchservice/vendorlist

Headers

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

Query Parameters

NameTypeDescription
typeenumType of vendor (Resume or Job).
This parameter is optional.
consumerKeystringConsumerKey to access the LENS api.
This parameter is optional.
vendorstringVendor name (max length : 50).
This parameter is optional.
localeenumLocale of the instance (en_us).
This parameter is optional.
instanceTypeenumInstance type to be used to search (LENSSEARCH or SPECTRUM).
This parameter is optional.
statusenumStatus of the vendor (Open or Close).
This parameter is optional.

Code Examples

curl --request GET \
  --url https://lensapi.burning-glass.com/v2.0/searchservice/vendorlist \
  --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/vendorlist \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/xml" \
  --header "Content-Type: application/xml"

Response Examples

{
  "status": true,
  "statusCode": "OK",
  "requestId": "c3811777-976f-4f56-b275-1bfac2e780a6",
  "responseData": {
    "vendorList": [
      {
        "vendorId": 8,
        "instanceId": 16,
        "vendor": "sampledemovendor",
        "locale": "en_us",
        "instanceType": "Spectrum",
        "status": "open",
        "type": "resume    ",
        "maxDocumentCount": 1000,
        "registeredDocumentCount": 10,
        "createdOn": "2015-11-03 00:00:00.000",
        "updatedOn": "2015-11-03 00:00:00.000"
      },
      {
        "vendorId": 20,
        "instanceId": 15,
        "vendor": "spectrumvendor",
        "locale": "en_us",
        "instanceType": "Spectrum",
        "status": "open",
        "type": "resume    ",
        "maxDocumentCount": 1000,
        "registeredDocumentCount": 0,
        "createdOn": "2015-11-04 00:00:00.000",
        "updatedOn": "2015-11-04 00:00:00.000"
      }
    ]
  },
  "timeStamp": "2015-11-25 20:42:48.376"
}
<GetVendorByCriteriaResponse>
    <Status>true</Status>
    <StatusCode>OK</StatusCode>
    <RequestId>442b9867-664f-42ef-94ef-a0b52f8d6abb</RequestId>
    <ResponseData>
        <VendorList>
            <VendorId>8</VendorId>
            <InstanceId>16</InstanceId>
            <Vendor>sampledemovendor</Vendor>
            <Locale>en_us</Locale>
            <InstanceType>SPECTRUM</InstanceType>
            <Status>open</Status>
            <Type>resume    </Type>
            <MaxDocumentCount>1000</MaxDocumentCount>
            <RegisteredDocumentCount>10</RegisteredDocumentCount>
            <CreatedOn>2015-11-03 00:00:00.000</CreatedOn>
            <UpdatedOn>2015-11-03 00:00:00.000</UpdatedOn>
        </VendorList>
        <VendorList>
            <VendorId>20</VendorId>
            <InstanceId>15</InstanceId>
            <Vendor>spectrumvendor</Vendor>
            <Locale>en_us</Locale>
            <InstanceType>Spectrum</InstanceType>
            <Status>open</Status>
            <Type>resume    </Type>
            <MaxDocumentCount>1000</MaxDocumentCount>
            <RegisteredDocumentCount>0</RegisteredDocumentCount>
            <CreatedOn>2015-11-04 00:00:00.000</CreatedOn>
            <UpdatedOn>2015-11-04 00:00:00.000</UpdatedOn>
        </VendorList>
    </ResponseData>
    <TimeStamp>2015-11-25 20:44:13.334</TimeStamp>
</GetVendorByCriteriaResponse>