# Group Vectorapi
Group of all vectorapi-related resources.

## Country 

Country resource is responsible for retrieving the countries list.

## Index [/vectorapi/country/index{?country_ids,limit,access_token}]

### Index [GET]

+ Parameters

    + country_ids (required, varchar, `1,2,3,4`)    
    + limit (optional, number, `10`)   
    + access_token (required, varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)
    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "vapi.alpha.devorch.com",
      "httpStatusCode": 200
    },
    "request": "country/index?params=vectorapi&country&index&json&1,2,3,4&10&<some_token>",
    "response": {
      "countries": [
        {
          "id": "2",
          "name": "Canada"
        },
        {
          "id": "4",
          "name": "Germany"
        },
        {
          "id": "3",
          "name": "United Kingdom"
        },
        {
          "id": "1",
          "name": "USA"
        }
      ],
      "total_records": "4"
    }
  }
}
+ **Other Optional Parameters**

    + Optional Parameters : limit, offset, pageNumber, total_records
    + Sort Options : columnName, orderBy
    + Parameter options (filter): country_id,fields - id,name,abbrivation,continent,longitude,iso3166a3    string(comma separated values).

## Get [/vectorapi/country/index{?search_by,search_value,limit,access_token}]

### Index [GET]

+ Parameters

    + search_by (optional, varchar, `name`)
    + search_value(optional, varchar, `india`)    
    + limit (optional, number, `10`)   
    + access_token (required, varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)
    + Body
{
    "envelope": {
        "header": {
            "apiVersion": "1.0",
            "baseUrl": "localhost",
            "httpStatusCode": 200
        },
        "request": "country/index?params=vectorapi&country&index&json&<some_token>&10&name&india",
        "response": {
            "countries": [
                {
                    "id": "217",
                    "name": "British Indian Ocean Territory"
                },
                {
                    "id": "86",
                    "name": "India"
                }
            ],
            "total_records": "2"
        }
    }
}

+ **Other Optional Parameters**

    + Optional Parameters : limit, offset, pageNumber, total_records
    + Search Options: search_by - coloumn name, search_value - value of the field
    + Sort Options : columnName, orderBy
    + Parameter options (filter): country_id,fields - id,name,abbrivation,continent,longitude,iso3166a3    string(comma separated values).