Resources

This page includes all endpoints available for the human resources module of Logiciel Actif.

List all resources

GET https://app.gem-books.com/api/resources

This endpoint allows you to get the list of your resources. The resources are returned, sorted by code (A-Z).

Query Parameters

NameTypeDescription

page

string

The number of page you wish to see. Default is 1.

per_page

string

The number of the desired result per page. Default is 20. Maximum is 100

Headers

NameTypeDescription

Authentication*

string

Bearer token.

Accept*

string

Should be application/json.

{
    "data": [
        {
            "id": 615,
            "user": null,
            "name": "m. st-onge",
            "inactive": 0,
            "language": null,
            "creation": "2020-05-28",
            "birth": null,
            "work_email": null,
            "email": null,
            "phone1": null,
            "phone2": null,
            "cell": null,
            "address": null,
            "city": null,
            "prov": "QC",
            "zip": null
        },
        {
            "id": 614,
            "user": null,
            "name": "m. provencher",
            "inactive": 0,
            "language": null,
            "creation": "2020-05-28",
            "birth": null,
            "work_email": null,
            "email": null,
            "phone1": null,
            "phone2": null,
            "cell": null,
            "address": null,
            "city": null,
            "prov": "QC",
            "zip": null
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 2
    },
    "success": true
}

Retrieve a resource

GET https://app.gem-books.com/api/resources/:id

This endpoint allows you to get the details of the resource.

Path Parameters

NameTypeDescription

id

string

The ID of the resource to retrieve

Headers

NameTypeDescription

Authentication

string

Bearer token.

Accept

string

Should be application/json.

{
    "data": {
        "id": 615,
        "user": null,
        "name": "m. st-onge",
        "inactive": 0,
        "language": null,
        "creation": "2020-05-28",
        "birth": null,
        "work_email": null,
        "email": null,
        "phone1": null,
        "phone2": null,
        "cell": null,
        "address": null,
        "city": null,
        "prov": "QC",
        "zip": null
    },
    "success": true
}

Create a resource

POST https://app.gem-books.com/api/resources

This endpoint allows you to create a resource. Returns the created resource.

Headers

NameTypeDescription

Authentication

string

Bearer token.

Accept

string

Should be application/json.

Content-type

string

Should be application/json.

Request Body

NameTypeDescription

code

string

Code of resource

name

string

Name of resource

{
    "data": {
        "id": 615,
        "user": null,
        "name": "m. st-onge",
        "inactive": 0,
        "language": null,
        "creation": "2020-05-28",
        "birth": null,
        "work_email": null,
        "email": null,
        "phone1": null,
        "phone2": null,
        "cell": null,
        "address": null,
        "city": null,
        "prov": "QC",
        "zip": null
    },
    "success": true
}

Update a resource

PUT https://app.gem-books.com/api/resources/:id

This endpoint allows you to update a specific resource. Returns the updated resource.

Path Parameters

NameTypeDescription

id

string

ID of resource to update

Headers

NameTypeDescription

Authentication

string

Bearer token.

Accept

string

Should be application/json.

Content-type

string

Should be application/json.

{
    "data": {
        "id": 615,
        "user": null,
        "name": "m. st-onge",
        "inactive": 0,
        "language": null,
        "creation": "2020-05-28",
        "birth": null,
        "work_email": null,
        "email": null,
        "phone1": null,
        "phone2": null,
        "cell": null,
        "address": null,
        "city": null,
        "prov": "QC",
        "zip": null
    },
    "success": true
}

Last updated