Back to resources

Exploring the Graviti api

Get api v1 connect announcements by id

Get an announcement by its identification number


GET/api/v1/Connect/announcements/{id}   

Get an announcement by its identification number

REQUEST INFORMATION

Parameters

Name

Type

Additional information

Id

String

Required

x-api-key

Header

Required

x-api-secret

Header

Required

 

RESPONSE INFORMATION

  • Code: 200
  • Description: successful
  • Media type: text/plain; application/json; text/json
  •  Links: no links

Example value|Schema

    {

      "id": "string",

      "isActive": true,

      "title": "string",

      "description": "string",

      "organizationId": "string",

      "accessTypeId": 0,

      "expiresAfterDays": 0,

      "announcementStatusId": 0,

      "created": "2023-12-06T11:23:03.221Z",

      "updated": "2023-12-06T11:23:03.221Z",

      "user": "string",

      "accessType": "string",

      "announcementStatus": "string",

      "active": "string"

    }

 

Field

Type

Description

Id

String

Internal ID to identify announcement

Is active

Boolean

indication if the announcement is active or inactive

Title

String

Title of the announcement

Description

String

Description of the announcement

Organization

String

Name of the organization

Access type id

Integer

Access type id to identify announcement access

Expires after days

Integer

The number of days which the announcement is valid for

Announcement status id

Integer

Announcement status ID to identify announcement status

Created

Datetime

Datetime when the announcement was created in the system

Updated

Datetime

Datetime when the announcement was last updated.

User

String

The name of the person who wrote the announcement

Access type

String

Announcement access type

Announcement tatus

String

Status of the announcement: draft, published, unpublished)

Active

String

indication if the announcement is active or inactive

 



Related topics