{"id":6595,"date":"2019-03-19T19:31:25","date_gmt":"2019-03-19T19:31:25","guid":{"rendered":"https:\/\/zappysys.com\/blog\/?p=6595"},"modified":"2019-03-21T14:53:10","modified_gmt":"2019-03-21T14:53:10","slug":"understand-http-status-codes-fix-common-errors-rest-api","status":"publish","type":"post","link":"https:\/\/zappysys.com\/blog\/understand-http-status-codes-fix-common-errors-rest-api\/","title":{"rendered":"Understand HTTP Status Code and Fix Common Errors in REST API"},"content":{"rendered":"

Introduction<\/h2>\n

\"Logo<\/a>Any time you send HTTP Request according to HTTP Standard<\/a>\u00a0using tools like ZappySys REST API Drivers<\/a> or SSIS Connectors<\/a>\u00a0you may receive web response along with HTTP Status Codes. Dealing with REST \/ SOAP API calls you may face errors and you may find it challenging to understand generic error message from server along with some Numeric value (Called HTTP Status Code).\u00a0 In this article we will try to decode certain status codes and discuss various way to solve it.<\/p>\n

Example of HTTP Error and Status Code<\/h2>\n

Before we dive deep on this topic of HTTP Errors Status Codes let’s check an example HTTP Error with Status Code 400 (BadRequest). As you notice we passed some bad data in Request Body to produce this error. As you may see in below screenshot there are few parts we need to configure to call REST API request.<\/p>\n

    \n
  1. URL\u00a0<\/strong> (and optionally parameters<\/strong> in URL)<\/li>\n
  2. Request Method<\/strong>\u00a0 (i.e. GET \/ POST)<\/li>\n
  3. Request Body<\/strong> (Optional – Not needed for GET request but for POST \/PUT API requests you may need to pass)<\/li>\n
  4. Request Content Type<\/strong> ( Optional – i.e. application\/xml . This is not needed for GET Request)<\/li>\n
  5. Request Headers<\/strong> (Optional – Many tools generate default headers behind the scene. In our example we passed only two headers but see how many more added automatically in below Raw View obtained by tools like Fiddler<\/a> )<\/li>\n<\/ol>\n

    Sample Request:<\/p>\n

    POST\r\nhttps:\/\/accounts.google.com\/o\/oauth2\/token\r\n\r\n>>>> HEADERS <<<<<\r\n\r\nUser-Agent: ZappySysApp\/1.0.2019.10310\r\nContent-Type: application\/xml\r\nAccept: *\/*\r\nCache-Control: no-cache\r\nHost: accounts.google.com\r\nContent-Length: 13\r\nExpect: 100-continue\r\nAccept-Encoding: gzip, deflate\r\nConnection: Keep-Alive\r\n\r\n>>>> BODY <<<<<\r\n\r\nsome bad data<\/pre>\n
    Sample Response:<\/p>\n
    HTTP\/1.1 400 Bad Request\r\n\r\n{\r\n  \"error\": {\r\n    \"code\": 400,\r\n    \"message\": \"Invalid JSON payload received. Unexpected token.\\nsome bad data\\n^\",\r\n    \"status\": \"INVALID_ARGUMENT\"\r\n  }\r\n}<\/pre>\n
    Here is a screenshot of SSIS REST API Task<\/a> which can be used for calling XML \/ JSON API to automate ETL workflows.<\/p>\n
    \"Example<\/a>
    Example of Calling REST API which returns HTTP Error Status Code 400 (Bad Request) – Invalid POST Body \/ Syntax Error<\/p><\/div>\n
    Common HTTP Error Status Codes \/ Reasons \/ Possible Fix<\/h2>\n
    Status codes can be anywhere between 100 to 505. Most of them documented here<\/a>\u00a0also here (RFC2616 – HTTP \/ 1.1)<\/a>. Out of these status codes we will discuss few most common ones in this article and how to fix them.<\/p>\n
    Microsoft has also provided great explanation for most common HTTP Status Code here<\/a>.<\/p>\n
    Status Code 400 – Bad Request<\/h3>\n
    Possible Reason(s):<\/strong><\/p>\n