PipeRiv

Notices

The notices endpoint is private and requires Premium API access.

GET /notices

Private endpoint. Provides the list of notices starting with the latest notice.

Note that the API pulls in new notices roughly every 10 minutes. If you are needing notices checked more often up to 1 minute intervals, that is possible but it requires an enterprise level account. Please contact support for more details.

Query Arguments

example: /notices?pipeline=transco&page=2

pipeline: string (optional)
This field will filter the notices to a specific pipeline. The slug of the pipeline should be used in this argument.

page: integer (optional)
This field is used for pagination and will load the specified page of results.

Result Values

id: integer
The PipeRiv id and primary key in the database. This value will be unique.

pipeline_id: integer
The id of the associated pipline. This is the same id that is listed when you call the `pipelines` API results.

subject: short string
The subject of the notice.

identifier: short string
The id of the noticed used by the pipeline. This value may not be unique across pipelines.

url: short string
The URL of the notice or the URL of the informational postings where the notice can be found.

category: short string
This is the category of the notice (like Critical, Non-Critical, etc.)

type: short string
This is the type of the notice (like Maintenance, Constraint, etc.)

status: short string
This is the status of the notice. Not all pipelines provide this information so it could be an empty.

notice: long text
This is the notice text stripped of any HTML tags.

html: long text
This is the notice text including HTML tags for formatting.

mobile: long text
This is the notice text including HTML tags modified for easy mobile display.

posted_at: datetime
The date and time when the pipeline posted the notice using the UTC timezone (note that some pipelines do not clarify what timezone is being used so a best estimate is used).

effective_at: datetime
The date and time the pipeline notice becomes effective using the UTC timezone (note that some pipelines do not clarify what timezone is being used so a best estimate is used).

end_at: datetime
The date and time the pipeline notice ends using the UTC timezone (note that some pipelines do not clarify what timezone is being used so a best estimate is used).

response_at: datetime
The date and time the pipeline notice response is needed using the UTC timezone (note that some pipelines do not clarify what timezone is being used so a best estimate is used).

piperiv_created_at: datetime
The date and time the notice was added to the PipeRiv system using the UTC timezone.

piperiv_updated_at: datetime
The date and time the notice was updated on the PipeRiv system using the UTC timezone.

Endpoint Example - All Notices

Below is a live example that can be copy and pasted.

curl https://www.piperiv.com/api/v1/ip/notices -u "demo:pr_api_live_01234demo56789_key"

Below is the expected result from that cURL call:

{
  "status": "success",
  "messages": [
    "The demo account has access to limited old data and can only view limited amounts of data (5 per page and can only go to page 3)."
  ],
  "meta": {
    "pagination": {
      "total_results": 123,
      "total_pages": 123,
      "page_previous": 1,
      "page_next": 2,
      "page_current": 1,
      "current_page": 1,
      "current_result": 1,
      "current_result_first": 1,
      "current_result_last": 5,
      "per_page": 5,
      "url_next": "https://www.piperiv.com/api/v1/ip/notices?page=2",
      "url_current": "https://www.piperiv.com/api/v1/ip/notices?page=1",
      "url_previous": "https://www.piperiv.com/api/v1/ip/notices?page=1"
    }
  },
  "data": [
    {
      "id": 7773,
      "pipeline_id": 39,
      "pipeline_name": "Equitrans",
      "pipeline_slug": "equitrans",
      "pipeline_url": "https://customers.equitransmidstream.com/IPWS-Equitrans/Home",
      "subject": "H-109 Pipeline Hydrotesting 11-11-24",
      "identifier": "116199",
      "url": "https://customers.equitransmidstream.com/ipwsApi/api/SystemWideNotice/?id=116199",
      "category": "Critical",
      "type": "OPERATIONAL FLOW ORDER/PLANNED SERVICE OUTAGE",
      "status": "",
      "notice": "\n\n\n\n\n\n\n\nSystem Wide Notice Detail...",
      "html": "\n<!-- Page 1 -->\n<a name=\"1\"></a>...",
      "mobile": "\n<a name=1></a>...",
      "posted_at": "2024-11-11 15:20:00",
      "effective_at": "2024-11-11 15:20:00",
      "end_at": "2025-02-28 00:00:00",
      "response_at": "",
      "piperiv_created_at": "2024-10-07 19:18:43",
      "piperiv_updated_at": "2024-10-07 19:18:43"
    },
    ...
    {                                                                                                                                                
      "id": 8533,
      "pipeline_id": 89,
      "pipeline_name": "WBI Energy Transmission",
      "pipeline_slug": "wbi",
      "pipeline_url": "https://transmission.wbienergy.com/informational_postings/site_map/site_map.aspx",
      "subject": "Capacity Constraint, 10/17/2024",
      "identifier": "7377",
      "url": "https://ebb.anrpl.com/Notices/NoticeView.asp?sPipelineCode=ANR&sSubCategory=Critical&sNoticeId=7377",
      "category": "Critical",
      "type": "Constraint",
      "status": "",
      "notice": "\r\n      \r\n        \r\n           - Detail...",
      "html": "<table id=\"tblNoticeDetail\" cellspacing=\"0\">...</table>...",
      "mobile": "<table id=\"tblNoticeDetail\" cellspacing=\"0\">...</table>...",
      "posted_at": "2024-10-16 16:31:00",
      "effective_at": "2024-10-17 09:00:00",
      "end_at": "2024-10-18 09:00:00",
      "response_at": "",
      "piperiv_created_at": "2024-10-16 21:38:07",
      "piperiv_updated_at": "2024-10-16 21:38:07"
  ]
}

Endpoint Example - Transco Notices