Api  >  Patron Config


Patron Config

Service URL /v1/tenants/{tenantId}/patrons/{patronId}

Service Endpoints


Patron Config

Endpoint URL /v1/tenants/{tenantId}/patrons/{patronId}/patron-config
Description
Gets patron info along with book & magazine checkouts
Http Messages
HTTP GET Request
GET /v1/tenants/{tenantId}/patrons/{patronId}/patron-config HTTP/1.1
UserAgent: fiddler
Host: api.rbdigital.com
Authorization: basic {basicToken}
Content-Type: application/json
Fiddler Request
fiddler request

HTTP GET Response
Response
{
  "tenantId": 1062,
  "patronId": 1256442,
  "searchScope": 1,
  "eBookCanBorrow": true,
  "eBookCanPlaceHold": true,
  "eAudioCanBorrow": true,
  "eAudioCanPlaceHold": true,
  "eBookStateId": 12,
  "audioBooks": {
    "checkouts": [
      {
        "interest": {
          "stateId": 32,
          "name": "checkout",
          "days": 21,
          "daysRemaining": 21,
          "renewalRemaining": 3,
          "canRenew": false,
          "isbn": "9781785750281",
          "expiresOn": "2017-08-15T00:00:00Z",
          "count": 0,
          "hasAttachment": false,
          "isOwned": true,
          "isAvailable": true,
          "effective": "2017-07-25T00:00:00Z"
        },
        "item": {
          "authors": [
            {
              "facet": "author",
              "text": "Stewart Sheargold",
              "token": "stewart-sheargold",
              "order": 0
            }
          ],
          "narrators": [
            {
              "facet": "narrator",
              "text": "Sylvester Mccoy",
              "token": "sylvester-mccoy",
              "order": 0
            },
            {
              "facet": "narrator",
              "text": "Bonnie Langford",
              "token": "bonnie-langford",
              "order": 0
            }
          ],
          "images": [
            {
              "name": "medium",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100017109/Z100017109_image_95x140.jpg"
            },
            {
              "name": "large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100017109/Z100017109_image_128x192.jpg"
            },
            {
              "name": "x-large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100017109/Z100017109_image_148x230.jpg"
            },
            {
              "name": "xx-large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100017109/Z100017109_image_512x512_iTunes.png"
            }
          ],
          "id": "596f32631bbb8a1210204bb1",
          "isbn": "9781785750281",
          "publisher": {
            "facet": "publisher",
            "text": "Big Finish Productions",
            "token": "big-finish-productions",
            "order": 0
          },
          "genres": [
            {
              "facet": "genre",
              "text": "Sci Fi",
              "token": "sci-fi",
              "order": 0
            }
          ],
          "language": "English",
          "audience": "Adult",
          "mediaType": "eAudio",
          "releasedDate": "2016-03-01T06:00:00Z",
          "series": {
            "count": 0,
            "facet": "series",
            "text": "Doctor Who",
            "token": "doctor-who",
            "order": 0
          },
          "fileSize": "44193256",
          "duration": "02:02:43",
          "bookTitle": {
            "facet": "title",
            "text": "Red",
            "token": "red",
            "order": 0
          },
          "title": "Red",
          "isFiction": true,
          "hasSubtitle": false,
          "hasAttachments": false,
          "hasDrm": false,
          "preReleaseOn": "2015-10-08T05:00:00Z",
          "scheduledReleaseOn": "2016-03-01T06:00:00Z",
          "isPreRelease": false,
          "shortDescription": "Subject 3999 - the Doctor. Subject has committed homicide. This subject now in constant redline. His propensity for violence remains unchecked. Analysis suggests...",
          "sortAuthor": "sheargold stewart",
          "sortTitle": "red",
          "sortNarrator": "mccoy sylvester",
          "audioFiles": [
            {
              "id": 1990867,
              "display": "Introduction",
              "filename": "Z100017109_0001_IN.mp3",
              "minutes": 5.23,
              "size": 1884056,
              "duration": "00:05:13"
            },
            {
              "id": 1990868,
              "display": "Chapter 1",
              "filename": "Z100017109_0002_C0001.mp3",
              "minutes": 28.30,
              "size": 10192496,
              "duration": "00:28:18"
            },
            {
              "id": 1990869,
              "display": "Chapter 2",
              "filename": "Z100017109_0003_C0002.mp3",
              "minutes": 29.81,
              "size": 10738328,
              "duration": "00:29:48"
            },
            {
              "id": 1990870,
              "display": "Chapter 3",
              "filename": "Z100017109_0004_C0003.mp3",
              "minutes": 29.93,
              "size": 10776560,
              "duration": "00:29:55"
            },
            {
              "id": 1990871,
              "display": "Chapter 4",
              "filename": "Z100017109_0005_C0004.mp3",
              "minutes": 29.45,
              "size": 10601816,
              "duration": "00:29:27"
            }
          ]
        },
        "asset": {
          "mediaType": "eAudio",
          "encryption": "",
          "minutes": 122.73,
          "size": 44193256,
          "actualMinutes": 122.72,
          "files": [
            {
              "id": 1990867,
              "display": "Introduction",
              "filename": "Z100017109_0001_IN.mp3",
              "downloadUrl": "http://api.rbdigital.com/v1/media/9781785750281/parts/1990867/download-url?s3=Z100017109&f=Z100017109_0001_IN",
              "minutes": 5.23,
              "size": 1884056
            },
            {
              "id": 1990868,
              "display": "Chapter 1",
              "filename": "Z100017109_0002_C0001.mp3",
              "downloadUrl": "http://api.rbdigital.com/v1/media/9781785750281/parts/1990868/download-url?s3=Z100017109&f=Z100017109_0002_C0001",
              "minutes": 28.30,
              "size": 10192496
            },
            {
              "id": 1990869,
              "display": "Chapter 2",
              "filename": "Z100017109_0003_C0002.mp3",
              "downloadUrl": "http://api.rbdigital.com/v1/media/9781785750281/parts/1990869/download-url?s3=Z100017109&f=Z100017109_0003_C0002",
              "minutes": 29.81,
              "size": 10738328
            },
            {
              "id": 1990870,
              "display": "Chapter 3",
              "filename": "Z100017109_0004_C0003.mp3",
              "downloadUrl": "http://api.rbdigital.com/v1/media/9781785750281/parts/1990870/download-url?s3=Z100017109&f=Z100017109_0004_C0003",
              "minutes": 29.93,
              "size": 10776560
            },
            {
              "id": 1990871,
              "display": "Chapter 4",
              "filename": "Z100017109_0005_C0004.mp3",
              "downloadUrl": "http://api.rbdigital.com/v1/media/9781785750281/parts/1990871/download-url?s3=Z100017109&f=Z100017109_0005_C0004",
              "minutes": 29.45,
              "size": 10601816
            }
          ],
          "bookmarks": [],
          "isbn": "9781785750281"
        }
      }
    ],
    "holds": [
      {
        "interest": {
          "stateId": 16,
          "name": "hold",
          "isbn": "9781781102633",
          "expiresOn": "2050-12-31T00:00:00Z",
          "queuePosition": 3,
          "totalCopies": 0,
          "isOwned": true,
          "isAvailable": false,
          "effective": "2017-07-25T00:00:00Z"
        },
        "item": {
          "authors": [
            {
              "facet": "author",
              "text": "J.K. Rowling",
              "token": "j-k-rowling",
              "order": 0
            }
          ],
          "narrators": [
            {
              "facet": "narrator",
              "text": "Jim Dale",
              "token": "jim-dale",
              "order": 0
            }
          ],
          "images": [
            {
              "name": "medium",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100104031/Z100104031_image_95x140.jpg"
            },
            {
              "name": "large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100104031/Z100104031_image_128x192.jpg"
            },
            {
              "name": "x-large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100104031/Z100104031_image_148x230.jpg"
            },
            {
              "name": "xx-large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/Z100104031/Z100104031_image_512x512_iTunes.png"
            }
          ],
          "id": "596f32641bbb8a1210205199",
          "isbn": "9781781102633",
          "publisher": {
            "facet": "publisher",
            "text": "Pottermore",
            "token": "pottermore",
            "order": 0
          },
          "genres": [
            {
              "facet": "genre",
              "text": "Juvenile Fiction",
              "token": "juvenile-fiction",
              "order": 0
            },
            {
              "facet": "genre",
              "text": "Fantasy",
              "token": "fantasy",
              "order": 0
            },
            {
              "facet": "genre",
              "text": "Humorous Fiction",
              "token": "humorous-fiction",
              "order": 0
            }
          ],
          "language": "English",
          "audience": "Young Adult",
          "mediaType": "eAudio",
          "releasedDate": "2016-03-23T05:00:00Z",
          "series": {
            "count": 0,
            "facet": "series",
            "text": "Harry Potter",
            "token": "harry-potter",
            "order": 0
          },
          "fileSize": "185621136",
          "duration": "08:35:30",
          "bookTitle": {
            "facet": "title",
            "text": "Harry Potter and the Sorcerer's Stone",
            "token": "harry-potter-and-the-sorcerers-stone",
            "order": 0
          },
          "title": "Harry Potter and the Sorcerer's Stone",
          "isFiction": true,
          "hasSubtitle": false,
          "hasAttachments": false,
          "hasDrm": false,
          "preReleaseOn": "2016-03-11T06:00:00Z",
          "scheduledReleaseOn": "2016-03-22T05:00:00Z",
          "isPreRelease": false,
          "shortDescription": "Turning the envelope over, his hand trembling, Harry saw a purple wax seal bearing a coat of arms; a lion, an eagle, a badger and a snake surrounding a large letter...",
          "sortAuthor": "rowling k",
          "sortTitle": "harry-potter-and-the-sorcerers-stone",
          "sortNarrator": "dale jim",
          "audioFiles": [
            {
              "id": 954321,
              "display": "Introduction",
              "filename": "Z100104031_0001_IN.mp3",
              "minutes": 0.48,
              "size": 175496,
              "duration": "00:00:28"
            },
            {
              "id": 954322,
              "display": "Chapter 1",
              "filename": "Z100104031_0002_C0001.mp3",
              "minutes": 5.25,
              "size": 1889672,
              "duration": "00:05:15"
            },
            {
              "id": 954323,
              "display": "Chapter 2",
              "filename": "Z100104031_0003_C0002.mp3",
              "minutes": 23.60,
              "size": 8496680,
              "duration": "00:23:36"
            },
            {
              "id": 954324,
              "display": "Chapter 3",
              "filename": "Z100104031_0004_C0003.mp3",
              "minutes": 21.76,
              "size": 7837016,
              "duration": "00:21:45"
            },
            {
              "id": 954325,
              "display": "Chapter 4",
              "filename": "Z100104031_0005_C0004.mp3",
              "minutes": 24.25,
              "size": 8732336,
              "duration": "00:24:15"
            },
            {
              "id": 954326,
              "display": "Chapter 5",
              "filename": "Z100104031_0006_C0005.mp3",
              "minutes": 24.38,
              "size": 8779856,
              "duration": "00:24:22"
            },
            {
              "id": 954327,
              "display": "Chapter 6",
              "filename": "Z100104031_0007_C0006.mp3",
              "minutes": 43.91,
              "size": 15812168,
              "duration": "00:43:54"
            },
            {
              "id": 954328,
              "display": "Chapter 7",
              "filename": "Z100104031_0008_C0007.mp3",
              "minutes": 38.23,
              "size": 13769024,
              "duration": "00:38:13"
            },
            {
              "id": 954329,
              "display": "Chapter 8",
              "filename": "Z100104031_0009_C0008.mp3",
              "minutes": 28.81,
              "size": 10376744,
              "duration": "00:28:48"
            },
            {
              "id": 954330,
              "display": "Chapter 9",
              "filename": "Z100104031_0010_C0009.mp3",
              "minutes": 18.53,
              "size": 6676880,
              "duration": "00:18:31"
            },
            {
              "id": 954331,
              "display": "Chapter 10",
              "filename": "Z100104031_0011_C0010.mp3",
              "minutes": 30.96,
              "size": 11151536,
              "duration": "00:30:57"
            },
            {
              "id": 954332,
              "display": "Chapter 11",
              "filename": "Z100104031_0012_C0011.mp3",
              "minutes": 25.55,
              "size": 9197168,
              "duration": "00:25:33"
            },
            {
              "id": 954333,
              "display": "Chapter 12",
              "filename": "Z100104031_0013_C0012.mp3",
              "minutes": 21.25,
              "size": 7650176,
              "duration": "00:21:15"
            },
            {
              "id": 955763,
              "display": "Chapter 13",
              "filename": "Z100104031_0014_C0013.mp3",
              "minutes": 35.65,
              "size": 12833096,
              "duration": "00:35:39"
            },
            {
              "id": 955764,
              "display": "Chapter 14",
              "filename": "Z100104031_0015_C0014.mp3",
              "minutes": 19.78,
              "size": 7125944,
              "duration": "00:19:46"
            },
            {
              "id": 955765,
              "display": "Chapter 15",
              "filename": "Z100104031_0016_C0015.mp3",
              "minutes": 21.26,
              "size": 7656440,
              "duration": "00:21:15"
            },
            {
              "id": 955766,
              "display": "Chapter 16",
              "filename": "Z100104031_0017_C0016.mp3",
              "minutes": 32.36,
              "size": 11653520,
              "duration": "00:32:21"
            },
            {
              "id": 955767,
              "display": "Chapter 17",
              "filename": "Z100104031_0018_C0017.mp3",
              "minutes": 41.23,
              "size": 14845784,
              "duration": "00:41:13"
            },
            {
              "id": 955768,
              "display": "Chapter 18",
              "filename": "Z100104031_0019_C0018.mp3",
              "minutes": 40.28,
              "size": 14503640,
              "duration": "00:40:16"
            },
            {
              "id": 955769,
              "display": "Chapter 19",
              "filename": "Z100104031_0020_C0019.mp3",
              "minutes": 15.95,
              "size": 5741600,
              "duration": "00:15:57"
            },
            {
              "id": 955770,
              "display": "Chapter 20",
              "filename": "Z100104031_0021_C0020.mp3",
              "minutes": 1.98,
              "size": 716360,
              "duration": "00:01:58"
            }
          ]
        }
      }
    ]
  },
  "eBooks": {
    "checkouts": [
      {
        "interest": {
          "stateId": 32,
          "name": "checkout",
          "days": 21,
          "daysRemaining": 21,
          "renewalRemaining": 3,
          "canRenew": false,
          "isbn": "9780743298810",
          "expiresOn": "2017-08-15T00:00:00Z",
          "count": 0,
          "hasAttachment": false,
          "isOwned": true,
          "isAvailable": true,
          "effective": "2017-07-25T00:00:00Z"
        },
        "item": {
          "authors": [
            {
              "facet": "author",
              "text": "Vince Flynn",
              "token": "vince-flynn",
              "order": 0
            }
          ],
          "images": [
            {
              "name": "medium",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/EB00577522/EB00577522_image_95x140.jpg"
            },
            {
              "name": "large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/EB00577522/EB00577522_image_128x192.jpg"
            },
            {
              "name": "x-large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/EB00577522/EB00577522_image_148x230.jpg"
            },
            {
              "name": "xx-large",
              "url": "https://d2cv0ie6dlin9h.cloudfront.net/EB00577522/EB00577522_image_512x512_iTunes.png"
            }
          ],
          "id": "596f31791bbb8a12101e52a1",
          "isbn": "9780743298810",
          "publisher": {
            "facet": "publisher",
            "text": "Atria Books",
            "token": "atria-books",
            "order": 0
          },
          "genres": [
            {
              "facet": "genre",
              "text": "Suspense Thriller",
              "token": "suspense-thriller",
              "order": 0
            },
            {
              "facet": "genre",
              "text": "General Fiction",
              "token": "general-fiction",
              "order": 0
            }
          ],
          "language": "English",
          "audience": "Adult",
          "mediaType": "eBook",
          "releasedDate": "2014-09-25T05:00:00Z",
          "series": {
            "count": 0,
            "facet": "series",
            "text": "Mitch Rapp",
            "token": "mitch-rapp",
            "order": 0
          },
          "bookTitle": {
            "facet": "title",
            "text": "Act of Treason",
            "token": "act-of-treason",
            "order": 0
          },
          "title": "Act of Treason",
          "isFiction": true,
          "hasSubtitle": false,
          "hasAttachments": false,
          "hasDrm": true,
          "preReleaseOn": "2014-09-20T05:00:00Z",
          "scheduledReleaseOn": "2014-09-25T05:00:00Z",
          "isPreRelease": false,
          "shortDescription": "#1 New York Times bestselling author of American Assassin-soon to be a major motion picture The fallout from a horrific Washington explosion has just begun-and so...",
          "sortAuthor": "flynn vince",
          "sortTitle": "act-of-treason"
        },
        "asset": {
          "mediaType": "eBook",
          "file": {
            "isbn": "9780743298810",
            "id": 214884,
            "filename": "EB00577522.epub",
            "format": "EPUB",
            "downloadUrl": "http://api.rbdigital.com/v1/media/214884/parts/214884/download-url?f=EB00577522.epub&ff=EPUB&acsRId=urn%3Auuid%3Ae6a7bad0-4f66-42d7-b3e5-82fa105d9c5b&tId=12857205&expDt=1502769600",
            "acsResourceId": "urn:uuid:e6a7bad0-4f66-42d7-b3e5-82fa105d9c5b",
            "textFormat": 0
          },
          "isbn": "9780743298810"
        }
      }
    ]
  }
}