API documentation

Filter

There are a lot of query params that you will need to use them, Check these examples to know how you can pass them:

• Pass just one param: /api/v1/federal_states?by_country=1
• Pass two params: /api/v1/countries?page=4&per_page=20
• Pass a hash param: /api/v1/countries?sorted[column]=title&sorted[direction]=asc
• Pass an array param: /api/v1/countries?by_ids[]=1&by_ids[]=2&by_ids[]=3&by_ids[]=4&by_ids[]=5 this one does not exist in the app

We are using JSONAPI format to return the success responses.

{
  "data": {
    "id": "9",
    "type": "country",
    "attributes": {
      "title": "Germany",
      "country_code": "DE"
    },
    "relationships": {
      "federal_states": {
        "data": [
          {
            "type": "federal_state",
            "id": "1"
          },
          {
            "type": "federal_state",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "federal_state",
      "attributes": {
        "title": "Berlin"
      },
      "relationships": {
        "cities": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2",
      "type": "federal_state",
      "attributes": {
        "title": "Bavaria"
      },
      "relationships": {
        "cities": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ]
}

If you want to deserialize it to a regular format, you can use jsonapi-deserializer js package. Using it you have below deserialized data:

{
    "id": "9",
    "title": "Germany",
    "country_code": "DE",
    "federal_states": [
        {
            "id": "1",
            "title": "Berlin"
        },
        {
            "id": "2",
            "title": "Bavaria"
        }
    ]
}

We have a same format to response errors:

{
    "errors": [
        {
            "title": "Invalid password",
            "detail": "Password is too short (minimum is 6 characters)"
        },
        {
            "detail": "invalid reset password token"
        }
    ]
}

• detail attributes is always there and describes the errors with details.
• title sometimes exists and describe the error in one or two words.