GET rbac/access certification campaigns
From Social ID Developers
Revision as of 15:28, 20 February 2024 by Gabriel.prado (Talk | contribs)
Contents |
Description
Searches for Access Certification Campaigns.
Resource URL
GET https://api.socialidnow.com/v1/rbac/access_certification_campaigns
Parameters
URL Parameters
ids | optional | comma separated list of access certification campaign ids. Example: ids=1,2,3. |
---|---|---|
page | optional | page number (each page contains page_size results). Default: 1. |
page_size | optional | maximum amount of results to be returned. Default: 8. |
name | optional | access certification campaign name. |
name:like | optional | part of access certification campaign name. |
status | optional | access certification campaign status. Allowed values: draft, scheduled, starting, active, finishing, done. |
allowed_reviewer_id | optional | allowed reviewer identifier. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
ok (200) | The request was successful. |
---|---|
unauthorized (401) | The authentication is wrong. See Authentication. |
internal_server_error (500) | An unknown error happened. |
Response Body
A successful search returns the following fields:
total | total amount of access certification campaigns found. |
---|---|
offset | amount of discarded access certification campaigns (page start). |
count | amount of access certification campaigns returned in this page. |
results | array with access certification campaign details: See response from GET rbac/access_certification_campaigns/:access_certification_campaign_id |
Examples
Without search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_certification_campaigns' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 0, "count": 3, "results": [ { "id": 1, "name": "First Access Certification Campaign", "description": "First Access Certification Campaign description", "status": "draft", "start_date": null, "end_date": null, "created_at": "2024-01-10T12:15:00Z", "updated_at": "2024-01-10T12:15:00Z" }, { "id": 2, "name": "Second Access Certification Campaign", "description": "Second Access Certification Campaign description", "status": "scheduled", "start_date": "2100-01-01T12:00:00Z", "end_date": "2100-02-01T12:00:00Z", "created_at": "2024-01-10T12:16:00Z", "updated_at": "2024-01-10T12:16:00Z" }, { "id": 3, "name": "Third Access Certification Campaign", "description": "Third Access Certification Campaign description", "status": "done", "start_date": "2024-01-20T12:00:00Z", "end_date": "2024-02-20T12:00:00Z", "created_at": "2024-01-10T12:17:00Z", "updated_at": "2024-01-10T12:17:00Z" } ] }
With search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_certification_campaigns?page_size=1&page=2' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 1, "count": 1, "results": [ { "id": 2, "name": "Second Access Certification Campaign", "description": "Second Access Certification Campaign description", "status": "scheduled", "start_date": "2100-01-01T12:00:00Z", "end_date": "2100-02-01T12:00:00Z", "created_at": "2024-01-10T12:16:00Z", "updated_at": "2024-01-10T12:16:00Z" } ] }