Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

This Example Project demonstrates how to consume this API endpoint within a C# project.

URI: https://app.cloudcardtools.com/api/people/{ id | email }

Example URI: https://app.cloudcardtools.com/api/people/123
Example URI: https://app.cloudcardtools.com/api/people/jon.doe@foo.edu
 

HTTP Method: GET

Required Headers: X-Auth-Token (see: Authentication)

Example HTTP Request Body
 (LEAVE REQUEST BODY EMPTY)
Example Response
200 OK
{
    "accountExpired": false,
    "accountLocked": false,
    "activatedDate": null,
    "additionalPhotos": {},
    "authorities": [
        {
            "class": "com.campuscardtools.myphotoid.Role",
            "id": 3,
            "authority": "ROLE_CARDHOLDER"
        }
    ],
    "currentPhoto": {
        "aspectRatio": 1,
        "classifications": [...],
        "domainClass": "com.campuscardtools.myphotoid.Photo",
        "id": 12061,
        "isAspectRatioCorrect": true,
        "links": {
            "bytes": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes"
        },
        "lowestClassification": 0.0185,
        "originalPhoto": {
            "id": 12060,
            "publicKey": "lotsofrandomlettersandnumbers",
            "links": {
                "bytes": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes"
            }
        },
        "person": {...},
        "publicKey": "lotsofrandomlettersandnumbers",
        "status": "PENDING"
    },
    "customFields": {
        "Campus": {
            "class": "com.campuscardtools.myphotoid.CustomFieldValue",
            "id": 11858,
            "customField": {...},
            "lastUpdated": "2017-11-21T13:38:23Z",
            "person": {
                "class": "com.campuscardtools.myphotoid.Person",
                "id": 18762
            },
            "value": "East"
        },
        "Name": {
            "class": "com.campuscardtools.myphotoid.CustomFieldValue",
            "id": 11857,
            "customField": {...},
            "lastUpdated": "2017-11-21T13:38:23Z",
            "person": {
                "class": "com.campuscardtools.myphotoid.Person",
                "id": 18762
            },
            "value": "Grace Hopper"
        }
    },
    "dateTermsAccepted": null,
    "domainClass": "com.campuscardtools.myphotoid.Person",
    "email": "grace.hopper@sharptop.io",
    "emailsReceived": [
        {
            "address": "grace.hopper@sharptop.io",
            "formattedTimestamp": "10-19-2017 11:23 AM EDT",
            "subject": "Your Photo Was Approved",
            "timestamp": "2017-10-19 11:23:17.0"
        },
        {
            "address": "grace.hopper@sharptop.io",
            "formattedTimestamp": "10-20-2017 02:29 PM EDT",
            "subject": "Instant Photo Feedback",
            "timestamp": "2017-10-20 14:29:29.0"
        },
        {
            "address": "grace.hopper@sharptop.io",
            "formattedTimestamp": "Jan 19 12:47 PM EST",
            "subject": "Your Photo Was Approved",
            "timestamp": "2018-01-19 12:47:53.0"
        },
        {
            "address": "grace.hopper@sharptop.io",
            "formattedTimestamp": "Jun 13 9:53 AM EDT",
            "subject": "Instant Photo Feedback",
            "timestamp": "2018-06-13 09:53:52.0"
        },
        {
            "address": "grace.hopper@sharptop.io",
            "formattedTimestamp": "Jun 13 9:54 AM EDT",
            "subject": "Instant Photo Feedback",
            "timestamp": "2018-06-13 09:54:30.0"
        },
        {
            "address": "grace.hopper@sharptop.io",
            "formattedTimestamp": "Jun 18 3:14 PM EDT",
            "subject": "Your Photo Was Approved",
            "timestamp": "2018-06-18 15:14:05.0"
        }
    ],
    "enabled": true,
    "id": 18762,
    "identifier": "S63455",
    "latestPhoto": null,
    "links": null,
    "organization": {
        "id": 8,
        "domainClass": "com.campuscardtools.myphotoid.Organization",
        "name": "SharpTop Company",
        "isPaid": true,
        "termsOfService": "...",
        "photoRequirements": [...],
        "customFields": [...],
        "customCssUrl": null,
        "useEmailAsUsername": true,
        "usePersonIdentifier": true,
        "personIdentifierLabel": "ID Number",
        "downloadStrategy": {
            "id": "ZIP",
            "name": "Zip File"
        },
        "downloadLabel": "Download Photos",
        "aspectRatio": {
            "class": "com.campuscardtools.myphotoid.AspectRatio",
            "id": 3,
            "description": "1:1",
            "height": 1,
            "width": 1
        },
        "preventMultiplePhotos": false,
        "approvalsPerDay": 0,
        "approvalsMadeToday": 2,
        "canApproveMorePhotosToday": true,
        "allowAutoCrop": true,
        "allowAutoRotate": true,
        "additionalPhotoTypes": []
    },
    "passwordExpired": false,
    "passwordResetRequired": false,
    "readOnly": false,
    "username": "grace.hopper@sharptop.io"
}
  • No labels