Skip to content

Author

GET /v3/author

List all authors.

Acl Action: AUTHOR list

Arguments:

  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to version.
  • dir - string: Either asc or desc.

Example Response:

{
    "items": [
        {
            "id": "3",
            "uuid": "AAAA-123",
            "slug": "dario-senger-md",
            "name": "Dario Senger MD",
            "email": "jadyn.abshire@pfannerstill.org",
            "tagline": "",
            "description": "Amet accusamus sunt quo quia rerum vel nobis. Voluptas voluptas sit itaque.",
            "status": "1",
            "created_at": "2016-12-07 20:51:22",
            "modified_at": "2017-02-16 18:25:53",
            "srn": "srn:tsn:ceo-core\/author:AAAA-123"
        },
        {
            "id": "10",
            "uuid": "BBBB-123",
            "slug": "dr-carey-keebler-dvm",
            "name": "Dr. Carey Keebler DVM",
            "email": "alison.gerhold@hotmail.com",
            "tagline": "",
            "description": "Saepe sapiente ex impedit qui. Eos eos excepturi est repellat.",
            "status": "1",
            "created_at": "2016-12-07 20:51:23",
            "modified_at": "2017-03-02 17:40:45",
            "srn": "srn:tsn:ceo-core\/author:BBBB-123"
        }
    ],
    "first": 1,
    "before": 1,
    "current": 1,
    "last": 1,
    "next": 1,
    "total_pages": 1,
    "total_items": 2,
    "limit": 50
}

GET /v3/author/{uuid}

Get single author

Acl Action: AUTHOR get

Example Response:

[
    {
        "id": "10",
        "uuid": "BBBB-123",
        "slug": "dr-carey-keebler-dvm",
        "name": "Dr. Carey Keebler DVM",
        "email": "alison.gerhold@hotmail.com",
        "tagline": "",
        "description": "Saepe sapiente ex impedit qui. Eos eos excepturi est repellat.",
        "status": "1",
        "created_at": "2016-12-07 20:51:23",
        "modified_at": "2017-03-02 17:40:45",
        "srn": "srn:tsn:ceo-core\/author:BBBB-123"
    }
]

POST /v3/author

Create new author

Acl Action: AUTHOR create

Example Request:

{
    'slug': 'test-user',
    'name': 'Test User',
    'email': 'test@example.com',
    'tagline': ''
    'description': ''
    'status': 1
}

Example Response: See GET /v3/author/{uuid}

PUT /v3/author/{uuid}

Update existing author.

Acl Action: AUTHOR update

Example Request: See POST /v3/author

Example Response: See POST /v3/author

DELETE /v3/author/{uuid}[,{uuid}...]

Remove author

Acl Action: AUTHOR delete

Example Response:

{
    "message": "ok"
}