child

Get Many Children

Get Many Children

Securitybearer
Request
query Parameters
select
Array of strings

Select Child fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "employeeId" "name" "birthdate"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Children. (e.g. limit=20)

offset
integer

Offset amount of received Children. (e.g. offset=20)

object

Sort received Children by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/child
Request samples 
curl --request GET \
  --url 'https://api.alexishr.com/v1/child?select=SOME_ARRAY_VALUE&filters=SOME_OBJECT_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&sort=SOME_OBJECT_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Create One Child

Create One Child

Securitybearer
Request
Request Body schema: application/json
required
employeeId
required
string
name
required
string
birthdate
required
string <date-time>
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/child
Request samples
application/json
{
  • "employeeId": "507f1f77bcf86cd799439011",
  • "name": "string",
  • "birthdate": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Child

Get One Child

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Child fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "employeeId" "name" "birthdate"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/child/{id}
Request samples 
curl --request GET \
  --url 'https://api.alexishr.com/v1/child/507f1f77bcf86cd799439011?select=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Child

Update One Child

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
required
string
birthdate
required
string <date-time>
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/child/{id}
Request samples
application/json
{
  • "name": "string",
  • "birthdate": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Child

Replace One Child

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
required
string
birthdate
required
string <date-time>
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/child/{id}
Request samples
application/json
{
  • "name": "string",
  • "birthdate": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Child

Delete One Child

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/child/{id}
Request samples 
curl --request DELETE \
  --url https://api.alexishr.com/v1/child/507f1f77bcf86cd799439011 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to timesheet