Match a Job

POST /DaaS/jobpricing

Match a single job and return data based on scope of client credentials.

URL

https://daasjobmatchapi.salary.com/DaaS/jobpricing

Method

POST

Request Headers

Authorization: Bearer {AccessToken}

Content-Type: application/json

Request Body

{
    "JobTitle": "string",
    "JobDesc": "string",
    "CompanyName": "string",
    "DataScope": {
    "CountryCode": "string",
    "State": "string",
    "City": "string",
    "ZipCode": "string",
    "NAICSCode": "string",
    "FTEValue": 0,
    "Revenue": 0
    }
}

Please reference “Field Definitions” and “Behavior” sections for detailed information about the fields and API behavior.

Example Request

curl -X 'POST' \
    'https://daasjobmatchapi.salary.com/DaaS/jobpricing' \
    -H 'accept: */*' \
    -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjA1NjE4Q0JBLTUzMzAtNEYxQi05NzI2LUY4OUQ2MkZCNTREMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJCRUQ0M0ZCMC1COUU1LTQ3ODAtOUNCRS01NTdFMUE2MUFDNzciLCJuYmYiOjE3MTMzNzkzODgsImV4cCI6MTcxMzk4NDE4OCwiaXNzIjoiU2FsYXJ5IiwiYXVkIjoiSm9iTWF0Y2hBUElDbGllbnQifQ.b71drGg3lFVApyoGAwQWz_H-1_bWPJDsx-Fuljleh3I' \
    -H 'Content-Type: application/json' \
    -d '{
    "JobTitle": "Accountant",
    "JobDesc": "Maintains financial records and ensures that financial transactions are properly recorded. Ensures the accuracy of entries to ledger accounts and reconciles subsidiary ledger accounts to the general ledger. Compiles financial data to aid more senior accountants in the preparation of balance sheets, profit and loss statements and other financial reports. Assists in analyzing current costs, revenues, financial commitments, and obligations incurred to predict future revenues and expenses. Typically requires a bachelor'\''s degree in accounting or finance. Typically reports to a supervisor or manager.",
    "CompanyName": "",
    "DataScope": {
    "CountryCode": "USA",
    "State": "MA",
    "City": "Boston",
    "ZipCode": "",
    "NAICSCode": "52",
    "FTEValue": 110,
    "Revenue": 0
    }
}'

Response Body

A JSON object with the salary data. If the request job was scoped to a specific location, company size, or industry, the salary data returned is adjusted to this scope and this is highlighted in the DataScope_ fields in the response body.

HTTP Status Code 200

This response body corresponds to the example request above.

{
    "Code": 1,
    "Data": {
    "MatchRating": "Confident",
    "Salary10": 75035.7202,
    "Salary25": 82861.1339,
    "Salary50": 91456.2604,
    "Salary75": 101136.3579,
    "Salary90": 109949.5811,
    "Comp10": 76199.7397,
    "Comp25": 85020.6399,
    "Comp50": 94709.1697,
    "Comp75": 106045.4164,
    "Comp90": 116366.477,
    "BonusTarget50": 8056.8984,
    "BonusTargetAvg": 7834.7791,
    "CurrencyCode": "USD",
    "DataScope_IndustryCode": "52",
    "DataScope_IndustryName": "Finance and Insurance",
    "DataScope_FTERange": "101-200",
    "DataScope_CountryCode": "USA",
    "DataScope_Region": "Northeast",
    "DataScope_State": "MA",
    "DataScope_City": "Boston",
    "JobFamilyName": "Accountants and Financial Personnel",
    "JobLevelName": "Senior (III-VI)"
    }
}

Common Errors

Missing Required Fields

200 HTTP Status Code, “Code”: -1 means no data is returned

{
    "Code": -1,
    "Message": "Get salary failed."
}

Incomplete Location

200 HTTP Status Code, “Code”: -1 means no data is returned

{
    "Code": -1,
    "Message": "Location request is incomplete"
}

FTE and Revenue Scope

200 HTTP Status Code, “Code”: -1 means no data is returned

{
    "Code": -1,
    "Message": "DataScope error: cannot scope job by both FTEValue and Revenue. Please only provide a value for one of these fields in the request."
}