json 这是data.usagjobs.gov API的Swagger定义。

Posted 2021-05-19

{
  "swagger": "2.0",
  "info": {
    "title": "USAJobs - Job Opportunity Announcements API",
    "description": "The REST based API is designed to support lightweight JOA content consumption by consumers.",
    "termsOfService": "",
    "version": "1"
  },
  "host": "data.usajobs.gov",
  "basePath": "/api",
  "schemes": [
    "https"
  ],
  "produces": [
    "application/json",
    "application/xml"
  ],
  "paths": {
    "/jobs/": {
      "get": {
        "summary": "Jobs Search",
        "description": "It is anticipated that this API will be leveraged by Commercial Job Boards, Mobile Applications and Social Media sites who desire to provide employment opportunities on their site. Typically in these commercial venues, the breadth of data presented to a user (job seeker) is much smaller than the detailed content provided on USAJOBS, as required by law.",
        "operationId": "jobSearch",
        "parameters": [
          {
            "name": "OrganizationID",
            "in": "query",
            "description": "Example AF for all Air Force or HE39 for CDC.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "Title",
            "in": "query",
            "description": "This is the job title - The title search will be treated as contains and will select all job announcements where the job title contains the value provided.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "Series",
            "in": "query",
            "description": "This is a 4 digit number which the Federal government uses to categorize and define jobs. For a complete list of series, please visit List by Occupational Series.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "MinSalary",
            "in": "query",
            "description": "Jobs are placed in salary buckets: $0-$24,999, $25,000-$49,999, $50,000-$74,999, $75,000-$99,999, $100,000-$124,999, $125,000-$149,999, $150,000-$174,999, $175,000-$199,999 and $200,000 or greater. So a search with a minimum salary of $15,500 will return jobs with a minimum salary in the $0-$24,999 range.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "MaxSalary",
            "in": "query",
            "description": "Jobs are placed in salary buckets: $0-$24,999, $25,000-$49,999, $50,000-$74,999, $75,000-$99,999, $100,000-$124,999, $125,000-$149,999, $150,000-$174,999, $175,000-$199,999 and $200,000 or greater. So a search with a maximum salary of $72,000 will return jobs with a maximum salary in the $50,000-$74,999 range.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "LocationID",
            "in": "query",
            "description": "The location id is either a valid USPS Zip Code or a 9-digit Duty Location Code. NOTE: Use of Location ID will only return job announcements posted to that specific location id. Separate multiple location ids with a semicolon.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "LocationName",
            "in": "query",
            "description": "The location id is either a valid USPS Zip Code or a 9-digit Duty Location Code. NOTE: Use of Location ID will only return job announcements posted to that specific location id. Separate multiple location ids with a semicolon.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "Country",
            "in": "query",
            "description": "Country name - e.g. United States. The list of countries used by USAJOBS is at https://schemas.usajobs.gov/Enumerations/CountryCode.xml. Use the contents of the Value element for the country name.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "CountrySubDivision",
            "in": "query",
            "description": "When searching in the United States, this is the state name. Currently, country subdivisions for foreign countries are not supported in a job search. The list of country subdivisions is at https://schemas.usajobs.gov/Enumerations/CountrySubdivision.xml",
            "type": "string",
            "format": "string"
          },
          {
            "name": "SES",
            "in": "query",
            "description": "Yes/No – Default is No. SES stands for Senior Executive Service which is comprised of the men and women charged with leading the continuing transformation of government.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "GradeLow",
            "in": "query",
            "description": "Must be 01 through 15. This is the starting grade for the job. (Caution: Fed speak ahead but it cannot be helped.) The grade along with series is used by the Federal government to categorize and define jobs.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "GradeHigh",
            "in": "query",
            "description": "Must be 01 through 15. This is the ending grade for the job. See grade low for more information.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "Keyword",
            "in": "query",
            "description": "Keyword will search for all of the words specified (or synonyms of the word) through the job announcement.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "Student",
            "in": "query",
            "description": "Yes/No – Default is No. When the Student query parameter is used and the value is set to Yes, only job announcements targeted for students will be included.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "Page",
            "in": "query",
            "description": "The Page query parameter is used to specify which page results are desired. The API can provide up to 5,000 results for a given query. Within those results, the Page parameter is leveraged to return the specific results for that page.",
            "type": "string",
            "format": "string"
          },
          {
            "name": "NumberOfJobs",
            "in": "query",
            "description": "The NumberOfJobs query parameter is used to specify the number of jobs to return per query. The maximum value is 250. The default value is 25. This will directly affect the total number of jobs return value and the page parameter. So it should be specified on every call if not using the default value.",
            "type": "string",
            "format": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/Job"
            }
          }
        },
        "tags": [
          "Jobs",
          "Government"
        ]
      }
    }
  },
  "definitions": {
    "Job": {
      "properties": {
        "TotalJobs": {
          "type": "integer",
          "format": "int64"
        },
        "JobData": {
          "$ref": "#/definitions/JobData"
        },
        "Pages": {
          "type": "integer",
          "format": "int64"
        }
      }
    },
    "JobData": {
      "properties": {
        "DocumentID": {
          "type": "string"
        },
        "JobTitle": {
          "type": "string"
        },
        "OrganizationName": {
          "type": "string"
        },
        "AgencySubElement": {
          "type": "string"
        },
        "SalaryMin": {
          "type": "string"
        },
        "SalaryMax": {
          "type": "string"
        },
        "SalaryBasis": {
          "type": "string"
        },
        "StartDate": {
          "type": "string"
        },
        "EndDate": {
          "type": "string"
        },
        "WhoMayApplyText": {
          "type": "string"
        },
        "PayPlan": {
          "type": "string"
        },
        "Series": {
          "type": "string"
        },
        "Grade": {
          "type": "string"
        },
        "WorkSchedule": {
          "type": "string"
        },
        "WorkType": {
          "type": "string"
        },
        "Locations": {
          "type": "string"
        },
        "AnnouncementNumber": {
          "type": "string"
        },
        "JobSummary": {
          "type": "string"
        },
        "ApplyOnlineURL": {
          "type": "string"
        }
      }
    }
  }
}