Convenius API API documentation

/locals

Resource to actions of locals like hospitals

/locals get post

get

Endpoint to list all locals

post

Endpoint to create a new local

Endpoint to list all locals

Request
Response

Query Parameters

length: (integer)
Quantity of items to return
Example:
```
10
```
offset: (integer)
Where items will be fetched must start

HTTP status code 200

Body

Type: application/json

Example:

{
  "meta" : {},
  "data" : [
    {
      "id" : 1,
      "name" : "Local 1",
      "type" : "hospital",
      "address" : {
        "street" : "Name of Street",
        "number": 10,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
      },
      "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
      }
    }
  ]
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "No locals found"}

Endpoint to create a new local

Request
Response

Body

Type: application/json

Schema:

{
  "meta" : {},
  "data" : [
    {
      "id" : 1,
      "name" : "Local 1",
      "type" : "hospital",
      "address" : {
        "street" : "Name of Street",
        "number": 10,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
      },
      "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
      }
    }
  ]
}

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Local has been created"}

/locals/{id} get put delete

Resource of actions about one local item

get

Endpoint to get item information

put

Endpoint to update item

delete

Endpoint to delete item

Endpoint to get item information

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "meta" : {},
  "data" : [
    {
      "id" : 1,
      "name" : "Local 1",
      "type" : "hospital",
      "address" : {
        "street" : "Name of Street",
        "number": 10,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
      },
      "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
      }
    }
  ]
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Local not found"}

Endpoint to update item

Request

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
  "meta" : {},
  "data" : [
    {
      "id" : 1,
      "name" : "Local 1",
      "type" : "hospital",
      "address" : {
        "street" : "Name of Street",
        "number": 10,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
      },
      "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
      }
    }
  ]
}

/locals/search get

get

Endpoint to list all locals

Request
Response

Query Parameters

Latitude: required (string)
Example:
```
13.232142
```
Longitude: required (string)
Example:
```
54.2345234
```
radius: (string)
length: (integer)
Quantity of items to return
Example:
```
10
```
offset: (integer)
Where items will be fetched must start

HTTP status code 200

Body

Type: application/json

Example:

{
  "meta" : {},
  "data" : [
    {
      "id" : 1,
      "name" : "Local 1",
      "type" : "hospital",
      "address" : {
        "street" : "Name of Street",
        "number": 10,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
      },
      "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
      }
    },
    {
      "id" : 2,
      "name" : "Local 2",
      "type" : "hospital",
      "address" : {
        "street" : "Name of Street",
        "number": 20,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
      },
      "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
      }
    }
  ]
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "No items found"}

/cares

Resource of actions of heath cares

/cares get post

get

Endpoint to list all health cares registered

post

Endpoint to create a new health care

Endpoint to list all health cares registered

Request
Response

Query Parameters

length: (integer)
Quantity of items to return
Example:
```
10
```
offset: (integer)
Where items will be fetched must start

HTTP status code 200

Body

Type: application/json

Example:

{
    "meta" : {},
    "data" : [
        {
            "_id" : "233423f34",
            "name" : "Teste 1",
            "address" : {
                "street" : "Name of Street",
                "number" : 100,
                "neighborhood" : "Name of Neighborhood",
                "city" : "Name of City",
                "state" : "Name of State",
                "country" : "Name of Country"
            },
            "geolocation" : {
                "latitude" : "1.3242352",
                "longitude" : "23.423432"
            }
        },
        {
            "_id" : "233423f3DW",
            "name" : "Teste 2",
            "address" : {
                "street" : "Name of Street",
                "number" : 100,
                "neighborhood" : "Name of Neighborhood",
                "city" : "Name of City",
                "state" : "Name of State",
                "country" : "Name of Country"
            },
            "geolocation" : {
                "latitude" : "1.3242352",
                "longitude" : "23.423432"
            }
        }
    ]
}

Endpoint to create a new health care

Request
Response

Body

Type: application/json

Schema:

{
	"meta" : {},
	"data" : {
		"_id" : "233423f34",
        "name" : "Teste 1",
        "address" : {
            "street" : "Name of Street",
            "number" : 100,
            "neighborhood" : "Name of Neighborhood",
            "city" : "Name of City",
            "state" : "Name of State",
            "country" : "Name of Country"
        },
        "geolocation" : {
            "latitude" : "1.3242352",
            "longitude" : "23.423432"
        }
	}
}

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Health care created"}

/cares/{id} get put delete

get

Endpoint to get health care from id

put

Endpoint to update item of care

delete

Endpoint to delete item

Endpoint to get health care from id

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
	"meta" : {},
	"data" : {
		"_id" : "233423f34",
        "name" : "Teste 1",
        "address" : {
            "street" : "Name of Street",
            "number" : 100,
            "neighborhood" : "Name of Neighborhood",
            "city" : "Name of City",
            "state" : "Name of State",
            "country" : "Name of Country"
        },
        "geolocation" : {
            "latitude" : "1.3242352",
            "longitude" : "23.423432"
        }
	}
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Health care not found"}

Endpoint to update item of care

Request
Response

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
    "name" : "Teste 1",
    "address" : {
        "street" : "Name of Street",
        "number" : 100,
        "neighborhood" : "Name of Neighborhood",
        "city" : "Name of City",
        "state" : "Name of State",
        "country" : "Name of Country"
    },
    "geolocation" : {
        "latitude" : "1.3242352",
        "longitude" : "23.423432"
    }
}

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Health care updated"}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Health care not found"}

Endpoint to delete item

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Health care deleted"}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Health care not found"}

/plans

Resource of actions about plans

/plans get post

get

Endpoint to list all plans

post

Endpoint to create a new item

Endpoint to list all plans

Request
Response

Query Parameters

length: (integer)
Quantity of items to return
Example:
```
10
```
offset: (integer)
Where items will be fetched must start

HTTP status code 200

Body

Type: application/json

Schema:

{
    "meta" : {},
    "data" : [
        {
            "id" : 1,
            "name" : "Plan Name",
            "code" : "code",
            "health_care" : {
                "id" : 1,
                "name" : "Health Care 1"
            }
        },
        {
            "id" : 2,
            "name" : "Plan Name",
            "code" : "code",
            "health_care" : {
                "id" : 2,
                "name" : "Health Care 2"
            }
        }
    ]
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "no plans found"}

Endpoint to create a new item

Request
Response

Body

Type: application/json

Schema:

{
    "name" : "Plan Name",
    "code" : "code",
    "health_care" : {
        "id" : 1,
        "name" : "Health Care 1"
    }
}

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Plan created"}

/plans/{id} get put delete

Resource of actions of an item

get

Endpoint to get item by Id

put

Endpoint to update an item by Id

delete

Endpoint to delete an item

Endpoint to get item by Id

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
	"meta" : {},
	"data" : [
		{
			"id" : 1,
		    "name" : "Plan Name",
			"code" : "code"
		}
	]
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Plan not found"}

Endpoint to update an item by Id

Request

URI Parameters

id: required (string)

Body

Type: application/json

Schema:

{
    "name" : "Plan Name",
    "code" : "code",
    "health_care" : {
        "id" : 1,
        "name" : "Health Care 1"
    }
}

/specialities

Resource of actions about specialities

/specialities get post

get

Endpoint to list all specialities

post

Endpoint to create a new speciality

Endpoint to list all specialities

Request
Response

Query Parameters

length: (integer)
Quantity of items to return
Example:
```
10
```
offset: (integer)
Where items will be fetched must start

HTTP status code 200

Body

Type: application/json

Example:

{
	"meta" : {},
	"data" : [
		{
			"_id" : "as332rf3f",
			"name" : "Teste 1"
		},
		{
			"_id" : "2de233f",
			"name" : "Teste 2"
		}
	]
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "No Speciality found"}

Endpoint to create a new speciality

Request
Response

Body

Type: application/json

Example:

{
	"name" : "Teste Entity"
}

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Speciality created"}

/specialities/{id} get delete

get

Endpoint to get item description

delete

Endpoint to delete speciality

Endpoint to get item description

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
	"name" : "Teste Entity"
}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Speciality not found"}

Endpoint to delete speciality

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{"message" : "Speciality removed"}

HTTP status code 404

Body

Type: application/json

Example:

{"message" : "Speciality not found"}

Convenius API API documentation version 1.0

/locals

get /locals

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

post /locals

Body

HTTP status code 200

Body

get /locals/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

put /locals/{id}

URI Parameters

Body

delete /locals/{id}

URI Parameters

HTTP status code 200

Body

get /locals/search

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

/cares

get /cares

Query Parameters

HTTP status code 200

Body

post /cares

Body

HTTP status code 200

Body

get /cares/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

put /cares/{id}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 404

Body

delete /cares/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

/plans

get /plans

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

post /plans

Body

HTTP status code 200

Body

get /plans/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

put /plans/{id}

URI Parameters

Body

delete /plans/{id}