100 lines
2.1 KiB
Markdown
100 lines
2.1 KiB
Markdown
# API Docs
|
|
|
|
<a name="list"></a>
|
|
## List
|
|
|
|
Details for country list api
|
|
##
|
|
##
|
|
|
|
####Endpoint
|
|
|
|
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
|
|
|
| Method | URI | Headers |
|
|
| : | :- | : |
|
|
| GET | `/countries` | Default |
|
|
|
|
### URL Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
### Data Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
> {success} Success Response
|
|
|
|
####Code `200`
|
|
####Content
|
|
```php
|
|
{
|
|
"countries": [
|
|
{
|
|
"id": 1,
|
|
"iso": "AF",
|
|
"name": "Afghanistan",
|
|
"iso3": "AFG",
|
|
"num_code": "4",
|
|
"phone_code": "+93",
|
|
"created_at": "2022-01-05T06:31:56.000000Z",
|
|
"updated_at": "2022-01-05T06:31:56.000000Z"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"iso": "AL",
|
|
"name": "Albania",
|
|
"iso3": "ALB",
|
|
"num_code": "8",
|
|
"phone_code": "+355",
|
|
"created_at": "2022-01-05T06:31:56.000000Z",
|
|
"updated_at": "2022-01-05T06:31:56.000000Z"
|
|
},
|
|
{
|
|
"id": 3,
|
|
"iso": "DZ",
|
|
"name": "Algeria",
|
|
"iso3": "DZA",
|
|
"num_code": "12",
|
|
"phone_code": "+213",
|
|
"created_at": "2022-01-05T06:31:56.000000Z",
|
|
"updated_at": "2022-01-05T06:31:56.000000Z"
|
|
},
|
|
{
|
|
"id": 4,
|
|
"iso": "AS",
|
|
"name": "American Samoa",
|
|
"iso3": "ASM",
|
|
"num_code": "16",
|
|
"phone_code": "+1684",
|
|
"created_at": "2022-01-05T06:31:56.000000Z",
|
|
"updated_at": "2022-01-05T06:31:56.000000Z"
|
|
},
|
|
{
|
|
"id": 5,
|
|
"iso": "AD",
|
|
"name": "Andorra",
|
|
"iso3": "AND",
|
|
"num_code": "20",
|
|
"phone_code": "+376",
|
|
"created_at": "2022-01-05T06:31:56.000000Z",
|
|
"updated_at": "2022-01-05T06:31:56.000000Z"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
> {danger} Unauthenticated Response
|
|
|
|
####Code `403`
|
|
####Content
|
|
```php
|
|
{
|
|
"message": "Something went wrong!"
|
|
}
|
|
```
|