Skip to content

3.2 - Return Structure

The answer is JSON. On the legacy path /api/idata/job_posting it is wrapped in the envelope below; on /api/jobs/az_jobs the body is what the envelope carries in Result.

Structure

{
     "StatusCode": 200,
     "Status": "ESUCC or EFAIL",
     "Message": "Request OK. ",
     "Debug": null,
     "Result":
          {}
}

Example

{
     "StatusCode": 200,
     "Status": "ESUCC",
     "Message": "Request OK. Request OK. {0}",
     "Debug": null,
     "Result" : {
          "message": {
               "description": "job posting data fetching success",
               "response_code": 3
          },
          "data": {
               "ndays": 7, 
               "job_posting": [
                    { 
                         "job_title": "-", 
                         "category": "Other/General Jobs", 
                         "company_name": "Apple Inc.", 
                         "contract_time": "full_time", 
                         "contract_type": "contract", 
                         "date": "2023-09-12", 
                         "geo_lat": "-", 
                         "geo_lng": "-", 
                         "job_country": "US", 
                         "job_description": "-", 
                         "job_id": "19e187xxxxxx5fa85c419516df624",
                         "job_location": "-", 
                         "remote": "0", 
                         "salary": "-", 
                         "salary_currency": "USD", 
                         "salary_frequency": "-", 
                         "url": "https://jobs.apple.com/en-us/details/200493565/applecare-bpr-systems-quality-project-manager?team=CUST", 
                         "timestamp": 1694476800, 
                         "is_active": "yes", 
                         "expiry_at": "-" 
                    }
               ]
          }
      } 
}

On Failure

{
     "StatusCode": 401,
     "Status": "EFAIL",
     "Message": "Invalid Timestamp or Request too old.",
     "Debug": null,
     "Result": null
}

Note (checked against the API on 2026-11-11)

The example was written before the current service. Today:

  • Result also carries "opSuccess": true, and message.response_code is 4.
  • Every posting carries the 22 fields of 3.3 - Data Dictionnary that the API returns, null when the posting has none: the example leaves out salary_min and salary_max.
  • On success Message is Request OK. Request OK. {0}, as in the example. A failure has Status EFAIL, Message Request Failed. followed by the reason, Result null, and the HTTP status in StatusCode: 400 for a parameter that is unknown, malformed or out of range, or an unknown time zone.
  • A refusal of the API key or of its plan (401, 403, 429, 503) is not in the envelope: it is {"status": "error", "message": "..."}. The 401 in the example (Invalid Timestamp or Request too old.) is no longer sent; a request that sends only the old AppKey header gets a 401 that says to send an API key in X-API-Key.