RBC API documentation version 1

https://api.reading.gov.uk/

/uk

/uk/{days} get

get /uk/{days}

Get the date that is 'days' working days in the past taking into account all UK public holidays.

URI Parameters

  • days: required (int)

    Example:

    1

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
  { 
    "Date":"2019-12-03",
    "Readable":"Tuesday 3rd of December",
    "WorkingDays":1
  }
}

/uk/workingdatediff/{fromDate}/{toDate} get

get /uk/workingdatediff/{fromDate}/{toDate}

Count the number of working days between two dates

URI Parameters

  • fromDate: required (date)

    year-month-day

    Example:

    2019-12-25
  • toDate: required (date)

    year-month-day

    Example:

    2019-12-26

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
  {
    "DateDiff":"3"
  }
}

/uk/workingday/{date} get

get /uk/workingday/{date}

Look-up whether the supplied date is a working day taking into account all UK public holidays.

URI Parameters

  • date: required (date)

    year-month-day

    Example:

    2019-07-01

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{ 
  "Date":"2019-07-01",
  "IsWorkingDay":true
}

/rbc

/rbc/gardenwaste/subscriptionstatus/{UPRN} get

get /rbc/gardenwaste/subscriptionstatus/{UPRN}

Return garden waste subscription service. If subscription end date is larger than current date time, status is set to the subscription end date. If the subscription end date is larger than current date time plus 6 weeks, the time difference is calculated and returned in status. If there is no subscription, "No Contract" is returned in status.

URI Parameters

  • UPRN: required (int)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "assisted": false,
    "collectionSchedule": "Wednesday Fortnightly",
    "nextcollection": "2020-02-12",
    "status": "2020-02-12"
}

/rbc/getaddresses/{postcode} get

get /rbc/getaddresses/{postcode}

Get all addresses for the supplied postcode

URI Parameters

  • postcode: required (postcode)

    Example:

    RG12AR

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "Addresses": [
        {
            "AccountSiteId": "71454",
            "AccountSiteUprn": "310072455",
            "SiteAddress2": "ST GILES CLOSE",
            "SiteAddressPrefix": "None",
            "SiteEasting": "471811.0",
            "SiteId": "64711",
            "SiteLatitude": "51.4510090644",
            "SiteLongitude": "-0.967964890157",
            "SiteNorthing": "172954.0",
            "SiteShortAddress": "ALDER HOUSE, FLAT 1, ST GILES CLOSE, RG1 2AR"
        },
        {
            "AccountSiteId": "21295",
            "AccountSiteUprn": "310072456",
            "SiteAddress2": "ST GILES CLOSE",
            "SiteAddressPrefix": "None",
            "SiteEasting": "471811.0",
            "SiteId": "64712",
            "SiteLatitude": "51.4510090644",
            "SiteLongitude": "-0.967964890157",
            "SiteNorthing": "172954.0",
            "SiteShortAddress": "ALDER HOUSE, FLAT 2, ST GILES CLOSE, RG1 2AR"
        },
        {
            "AccountSiteId": "76187",
            "AccountSiteUprn": "310072457",
            "SiteAddress2": "ST GILES CLOSE",
            "SiteAddressPrefix": "None",
            "SiteEasting": "471811.0",
            "SiteId": "64713",
            "SiteLatitude": "51.4510090644",
            "SiteLongitude": "-0.967964890157",
            "SiteNorthing": "172954.0",
            "SiteShortAddress": "ALDER HOUSE, FLAT 3, ST GILES CLOSE, RG1 2AR"
        }
    ]
}

/rbc/getbinimage/{name} get

get /rbc/getbinimage/{name}

Get a reference to an image for the specified bin type

URI Parameters

  • name: required (string)
  • UPRN: required (int)

    Example:

    310019831

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{

}

/rbc/getcollectiondetails/{UPRN}/{roundCode} get

get /rbc/getcollectiondetails/{UPRN}/{roundCode}

Given a UPRN and RoundCode get details of the round.

URI Parameters

  • UPRN: required (int)

    Example:

    310045409
  • roundCode: required (string)

    Example:

    GREEN1

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "RoundID": 9,
    "ServiceID": 3,
    "ServiceItemDescription": "Garden Waste 240 litre bin",
    "ServiceItemID": 11
}

/rbc/getworksheetcompletionmessage/{REF} get

get /rbc/getworksheetcompletionmessage/{REF}

Get the completion message for a worksheet assuming already completed

URI Parameters

  • REF: required (string)

    Example:

    FS-Case-158596225

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "Message": "Reason unable to complete"
}

/rbc/getcorrectuprn/{accountSiteUPRN}/{accountSiteID} get

get /rbc/getcorrectuprn/{accountSiteUPRN}/{accountSiteID}

Get the correct UPRN for this property taking into account whether the property has a parent

URI Parameters

  • accountSiteUPRN: required (int)

    Example:

    310040413
  • accountSiteID: required (int)

    Example:

    147

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "UPRN": 310040413
}

/rbc/getworksheets/{UPRN} get

get /rbc/getworksheets/{UPRN}

Get worksheets for property

URI Parameters

  • UPRN: required (int)

    Example:

    310021396

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
  "Worksheets": [
      {
          "AuthorityName": "Reading Borough Council",
          "WorksheetApprovedDate": "0001-01-01 00:00:00",
          "WorksheetAssignedToID": 53,
          "WorksheetAssignedToName": "Operations",
          "WorksheetAssignedToTypeID": 2,
          "WorksheetCompletedDate": "0001-01-01 00:00:00",
          "WorksheetCreatedBy": "PS API",
          "WorksheetCreatedDate": "2019-09-25 14:28:58",
          "WorksheetDueByDate": "2019-09-30 00:00:00",
          "WorksheetEscalatedDate": "2019-09-26 23:59:59",
          "WorksheetExpiryDate": "2019-09-26 23:59:59",
          "WorksheetID": 6099,
          "WorksheetPaymentDate": "0001-01-01 00:00:00",
          "WorksheetStartDate": "2019-09-25 00:00:00",
          "WorksheetStatusID": 1,
          "WorksheetStatusName": "Open",
          "WorksheetSubject": "Missed Collection Domestic",
          "WorksheetType": "Missed Collection Domestic",
          "WorksheetWorkLocationAddress": "Hawk Cottages, Silver Street, Reading, Reading, Reading, ",
          "WorksheetWorkLocationEasting": 471890.0,
          "WorksheetWorkLocationLatitude": 51.44864366360733,
          "WorksheetWorkLocationLongitude": -0.9668813583247992,
          "WorksheetWorkLocationNorthing": 172692.0
      }
  ]

/rbc/getworksheetshtml/{UPRN} get

get /rbc/getworksheetshtml/{UPRN}

Get worksheets for property in html table format

URI Parameters

  • UPRN: required (int)

    Example:

    310040413

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "Worksheets": "<table id=\"worksheetsTable\" style=\"width:100%; border-spacing: 0px !IMPORTANT;\"><tr><td><table class=\"worksheetRecord\">\n        <tr class='worksheetRow'>\n            <td>Missed Collection Domestic</td>\n        </tr><tr class='worksheetRow'>\n            <td>Created on: 2019-09-25</td>\n        </tr><tr class='worksheetRow'>\n            <td>We have received your request and will return before the next scheduled collection.</td>\n        </tr>\n    </table></td></tr></table></tr></table>",
    "isData": true
}

/rbc/mycollections/{Address} get

get /rbc/mycollections/{Address}

Get the next bin collections for address

URI Parameters

  • Address: required (string)

    Address with % as spaces and comma before postcode

    Example:

    40%20Caversham%20Road%20Reading,%20RG17EB

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "Collections": [
        {
            "Date": "05/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Recycling Collection Service"
        },
        {
            "Date": "12/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Domestic Waste Collection Service"
        },
        {
            "Date": "19/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Recycling Collection Service"
        },
        {
            "Date": "26/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Domestic Waste Collection Service"
        }
    ]
}

/rbc/mycollections/{UPRN} get

get /rbc/mycollections/{UPRN}

Get the next bin collections for uprn

URI Parameters

  • UPRN: required (int)

    Example:

    310045409

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
    "Collections": [
        {
            "Date": "05/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Recycling Collection Service"
        },
        {
            "Date": "12/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Domestic Waste Collection Service"
        },
        {
            "Date": "19/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Recycling Collection Service"
        },
        {
            "Date": "26/02/2020 00:00:00",
            "Day": "Wednesday",
            "Service": "Domestic Waste Collection Service"
        }
    ]
}

/rbc/worksheets/{UPRN} get

get /rbc/worksheets/{UPRN}

Get all open worksheets for UPRN

URI Parameters

  • UPRN: required (int)

    Example:

    310045409

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
  "Worksheets": [
      {
          "WorksheetPaymentDate": "0001-01-01 00:00:00",
          "WorksheetAssignedToTypeID": 2,
          "WorksheetWorkLocationAddress": "6, GRANVILLE ROAD, READING, READING, READING, RG30 3QD",
          "WorksheetID": 6071,
          "WorksheetExpiryDate": "2019-09-14 23:59:59",
          "WorksheetSubject": "Missed Collection Garden",
          "WorksheetCreatedBy": "PS API",
          "WorksheetEscalatedDate": "2019-09-14 23:59:59",
          "WorksheetWorkLocationEasting": 468968.0,
          "WorksheetAssignedToName": "Operations",
          "AuthorityName": "Reading Borough Council",
          "WorksheetStatusName": "Open",
          "WorksheetWorkLocationLongitude": -1.0090145455580537,
          "WorksheetWorkLocationLatitude": 51.44475415047257,
          "WorksheetDueByDate": "2019-10-13 00:00:00",
          "WorksheetType": "Missed Collection Garden",
          "WorksheetAssignedToID": 53,
          "WorksheetApprovedDate": "0001-01-01 00:00:00",
          "WorksheetWorkLocationNorthing": 172219.0,
          "WorksheetCompletedDate": "0001-01-01 00:00:00",
          "WorksheetStatusID": 1,
          "WorksheetCreatedDate": "2019-09-13 09:22:01",
          "WorksheetStartDate": "2019-09-13 00:00:00"
      }
    ]
}