Organizations

List of organizations

Cuando se obtiene el listado de organizaciones, siempre se devuelve el listado de las organizaciones de las que el usuario es miembro.

GET /api/v1/organizations/
Query Parameters
  • favorites – Filtra las organizaciones favoritas del usuario.

Ejemplo de petición

GET /api/v1/organizations/ HTTP/1.1
Content-Type: application/json

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "count": 4,
    "next": null,
    "previous": null,
    "results": [
        {
            "code": "111111",
            "created": "2020-03-16T14:10:29.953623Z",
            "id": 9,
            "name": "TESTKUND EHANDEL",
            "organization_id": "7000000000000010199",
            "parent_code": ""
        },
        {
            "code": "111111100",
            "created": "2020-03-16T14:10:29.968417Z",
            "id": 10,
            "name": "C-SILVERLOD 9822",
            "organization_id": "7000000000000010200",
            "parent_code": "111111"
        },
        {
            "code": "111111200",
            "created": "2020-03-16T14:10:29.982463Z",
            "id": 11,
            "name": ".",
            "organization_id": "7000000000004107796",
            "parent_code": "111111"
        },
        {
            "code": "111111300",
            "created": "2020-03-16T14:10:29.995980Z",
            "id": 12,
            "name": "KUND",
            "organization_id":
            "7000000000004108463",
            "parent_code":
            "111111"
        }
    ]
}

Add to favorites

Cualquier usuario puede añadir las organizaciones de su lista a favoritos, para ello realizará esta llamada del API indicando el organization_id.

POST /api/v1/organizations/{organization_id}/favorite/

Ejemplo de petición

POST /api/v1/organizations/7000000000000010199/favorite/ HTTP/1.1
Content-Type: application/json

Ejemplo de respuesta

HTTP/1.1 200 OK

Remove from favorites

Para eliminar una organización de favoritos se realizará esta llamada del API indicando el organization_id.

POST /api/v1/organizations/{organization_id}/unfavorite/

Ejemplo de petición

POST /api/v1/organizations/7000000000000010199/unfavorite/ HTTP/1.1
Content-Type: application/json

Ejemplo de respuesta

HTTP/1.1 200 OK

Credit check

Se puede comprobar de forma explícita el estádo de crédito del usuario en una organización usando esta llamada del API indicando el organization_id.

GET /api/v1/credit-check/{organization_id}/

Ejemplo de petición

GET /api/v1/credit-check/7000000000000010199/ HTTP/1.1
Content-Type: application/json

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "credit": true
}