Common Models

Folder

The following is an example of a Folder.

{
  "folderId":44,
  "name":"API Generated Lists"
}

Each Folder has the following properties:

Property	Type	Description
`folderId`	int	Unique identifier for the Folder
`name`	string	Folder name

Map Region

The following is an example of a Map Region within a Folder.

{
  "mapRegionId": 12345,
  "name": "City of Cambridge",
  "description": null,
  "dateCreated": "2024-04-12T12:00:00Z",
  "dateRefreshed": "2024-07-12T12:00:00Z",
  "mapRoutes": [
    {
      "mapRouteId": 321,
      "name": "City of Cambridge Turf 01",
      "savedListId": 111,
      "routeNumber": 1,
      "routeSize": 100,
      "doorCount": 91,
      "phoneCount": 87,
      "printedList": {
        "number": "49099700-14646",
        "dateCreated": "2024-10-11T08:46:00Z",
        "createdBy": {
          "userId": 119874,
          "firstName": "API",
          "lastName": "User"
        }
      }
    },
    {
      "mapRouteId": 321,
      "name": "City of Cambridge Turf 02",
      "savedListId": 222,
      "routeNumber": 2,
      "routeSize": 50,
      "doorCount": 47,
      "phoneCount": 35,
      "printedList": {
        "number": "49099701-57967",
        "dateCreated": "2024-10-11T08:46:00Z",
        "createdBy": {
          "userId": 119874,
          "firstName": "API",
          "lastName": "User"
        }
      }
    }
  ]
}

Each Map Region has the following properties:

Property	Type	Description
`mapRegionId`	int	Identifier for the Map Region
`name`	string	Map Region name
`description`	string	Map Region description
`dateCreated`	date	Date and Time the Map Region was created
`dateRefreshed`	date	Date and Time the Map Region was last refreshed
`mapRoutes`	array	Array of Map Routes associated with the Map Region

Map Route

The following is an example of a Map Route within a Map Region.

{
  "mapRouteId": 321,
  "name": "City of Cambridge Turf 01",
  "savedListId": 111,
  "routeNumber": 1,
  "routeSize": 100,
  "doorCount": 91,
  "phoneCount": 87,
  "printedList": {
    "number": "49099700-14646",
    "dateCreated": "2024-10-11T08:46:00Z",
    "createdBy": {
      "userId": 119874,
      "firstName": "API",
      "lastName": "User"
    }
  }
}

Each Map Route has the following properties:

Property	Type	Description
`mapRouteId`	int	Identifier for the Map Route
`name`	string	Map Route name
`savedListId`	int	Identifier for the Saved List underlying the Map Route
`routeNumber`	int	Index number of the Map Route within the Map Region
`routeSize`	int	Number of people within the Map Route
`doorCount`	int	Number of unique doors within the Map Route
`phoneCount`	int	Number of unique phone numbers within the Map Route
`printedList`	object	The Printed List associated with the Map Route