Skip to content

Update SalaryService.md #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 19, 2022
Merged

Update SalaryService.md #179

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2b73a7
Update SalaryService.md
rehrenfeld Sep 28, 2022
5edc44c
Adress comments
rehrenfeld Oct 5, 2022
68d3490
Add support for US & OG
rehrenfeld Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion SalaryService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ e.g.: How much does a `Customer service representative` make per `year` in `Chic

The Salary service is available at `/core/salary`.

OG data is now supported, you can pass hostite and country to query only on OG data.

Request Structure
-----------

Expand All @@ -29,7 +31,8 @@ Requests consist of:
|`cbsa_code` | Optional | string | Unique Identifiers for US metropolitan statistical areas. |
|`postal_code` | Optional | string | A postal code.|
|`salary_period` | Yes | string | Possible values are "Year", "Hour". |
|`country` | Yes | string |An ISO-3166 country code.|
|`country` | Yes | string | An ISO-3166 country code.|
|`hostsite` | Optional | string | A valid CareerBuilder hostsite.("US", "OG" are supported for now). Defaulted to US if not provided |

Example cURL request with cbsa_code:

Expand Down Expand Up @@ -77,6 +80,23 @@ curl -X POST \
"country": "US"
}'
```

Example cURL request with hostsite request:

```
curl -X POST \
https://api.careerbuilder.com/core/salary \
-H 'Accept: application/json;version=1.0' \
-H 'Authorization: <BEARER_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"carotene_id": "43.1",
"salary_period": "year",
"country": "UK"
"hostsite": "OG"
}'
```

Response Structure
-----------
The returned response is a salary information of a given carotene id and location
Expand Down