Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

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


URI: https://api.onlinephotosubmission.com/api/people/{ id | email | identifier }

...

Code Block
titleExample Response
200 OK

{
    "accountExpired": false,
    "accountLocked": false,
    "activatedDate": "2015-04-11T17:26:28Z"null,
    "additionalPhotoRequired": truefalse,
    "additionalPhotos": {
        "Government Issued ID": null
    },
    "authorities": [
        {
            "class": "com.campuscardtools.myphotoid.Role",
            "id": 43,
            "authority": "ROLE_DIRECTORCARDHOLDER"
        },
    ],
   { "canSwitchOrganizations": false,
    "canViewOrganizationList": false,
    "classcurrentPhoto": "com.campuscardtools.myphotoid.Role",null,
    "customFields": {
        "idNotes": 2,{
            "authorityclass": "ROLE_OFFICE"com.campuscardtools.myphotoid.CustomFieldValue",
            },"id": 413609,
            "customField": {
                "class": "com.campuscardtools.myphotoid.RoleCustomField",
                "id": 3,100067
            "authority": "ROLE_CARDHOLDER"},
         }     ]"lastUpdated": "2019-12-04T17:47:09Z",
    "currentPhoto": {         "aspectRatioperson": 0.75,{
        "classifications": [          "class": "com.campuscardtools.myphotoid.Person",
  {                 "id": 145302,236680
                "score": 0.9963,
   },
            "requirementNamevalue": "Bacon"Helper
Bot"        }
    },
        ],
"dateTermsAccepted": null,
       "domainClass": "com.campuscardtools.myphotoid.PhotoPerson",
    "email": "john.arnold+rrtest@gmail.com",
    "helperBotReviewedemailGroup": true,{
        "id": 24400423,
        "isAspectRatioCorrectname": false"Default",
        "linksreceivableEmails": {"welcome,login,approval,denial,BAD,GOOD,MAYBE"
    },
    "enabled": true,
    "byteshomeOrganization": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1.jpg"{
        "id": }92,
        "lowestClassificationhasDescendents": 0.9963false,
        "originalPhotodescendents": {[]
       },
    "id": 243992236680,
    "identifier": "K0006",
      "publicKeylinks": "u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo"null,
            "links"organization": {
        "id": 92,
        "bytesdomainClass": "https://s3.amazonaws.com/photos.onlinephotosubmissioncampuscardtools.com/u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vomyphotoid.jpgOrganization",
        "name": "Test Org.",
 }         }"isPaid": true,
        "persontermsOfService": {null,
        "photoRequirements": [
  "id": 90,         {
   "username": "director@sharptop.co",
            "emailid": "director@sharptop.co",440,
                "identifieruniqueName": "d256436Face Camera",
                "organizationrequirement": {"Must be positioned directly facing the camera",
          "id": 92,     "listIndex": 4,
          "name": "Test Org.",    "hidden": false
           "photoRequirements": [...] },
                "identifier": null,{
                "badPhotoThresholdid": 0.4442,
                "goodPhotoThresholduniqueName": 0.8"HelperBot",
            },    "requirement": "Do not delete",
     "additionalPhotos": [],
            "additionalPhotoRequiredlistIndex": true6,
                "previouslyApprovedPhotohidden": { true
            },
           "aspectRatio": 0, {
                "classificationsid": []441,
                "domainClassuniqueName": "com.campuscardtools.myphotoid.PhotoLook At Camera",
                "helperBotReviewedrequirement": false "Eyes should be open and looking at the camera",
                "idlistIndex": 1365,
                "isAspectRatioCorrecthidden": false,
            },
       "links": {    {
                "bytesid": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936.jpg" 438,
                "uniqueName":     }"Color Photo",
                "lowestClassificationrequirement": null "Must be a color photo",
                "originalPhotolistIndex": null2,
                "personhidden": {false
            },
       "id": 90,    {
                "usernameid": "director@sharptop.co",
   436,
                "emailuniqueName": "director@sharptop.coCrop",
                "requirement": "Should be cropped slightly "identifier": "d256436",
   above head to middle of chest",
                "organizationlistIndex": { 0,
                "hidden": false
           "id": 92},
            {
           "name": "Test Org.",   "id": 439,
                    "photoRequirementsuniqueName": [...],
       "No Accessories",
                "identifierrequirement": null,"Must not include sunglasses or  hat",
                  "badPhotoThreshold": 0.4,
                        "goodPhotoThreshold": 0.8
                    },
                    "additionalPhotos": [],
                    "additionalPhotoRequired": true
                },
                "personHasApprovedPhoto": true,
                "publicKey": "419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936",
                "status": "DONE"
            }
        },
        "personHasApprovedPhoto": true,
        "publicKey": "9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1",
        "status": "PENDING"
    },
    "customFields": {
        "First Name": null,
        "Last Name": null
    },
    "dateTermsAccepted": "2015-05-24T06:44:54Z",
    "domainClass": "com.campuscardtools.myphotoid.Person",
    "email": "director@sharptop.co",
    "emailsReceived": [
        {
            "address": "director@sharptop.co",
            "formattedTimestamp": "10-19-2017 11:23 AM EDT",
            "subject": "Your Photo Was Approved",
            "timestamp": "2017-10-19 11:23:17.0"
        },
        {
            "address": "director@sharptop.co",
            "formattedTimestamp": "10-20-2017 02:29 PM EDT",
            "subject": "Instant Photo Feedback",
            "timestamp": "2017-10-20 14:29:29.0"
        },
        {
            "address": "director@sharptop.co",
            "formattedTimestamp": "Jan 19 12:47 PM EST",
            "subject": "Your Photo Was Approved",
            "timestamp": "2018-01-19 12:47:53.0"
        },
        {
            "address": "director@sharptop.co",
            "formattedTimestamp": "Jun 20 12:34 AM EDT",
            "subject": "Instant Photo Feedback",
            "timestamp": "2018-06-20 00:34:42.0"
        },
        {
            "address": "director@sharptop.co",
            "formattedTimestamp": "Sep 26 10:07 AM EDT",
            "subject": "Instant Photo Feedback",
            "timestamp": "2018-09-26 10:07:24.0"
        }
    ],
    "enabled": true,
    "homeOrganization": {
        "id": 8,
        "hasDescendents": true,
        "descendents": [
            {
                "id": 92
            },
            {
                "id": 100064
            },
            {
                "id": 46
            },
            {
                "id": 100079
            },
            {
                "id": 100047
            },
            {
                "id": 100096
            },
            {
                "id": 87
            },
            {
                "id": 91
            }
        ]
    },
    "id": 90,
    "identifier": "d256436",
    "links": null,
    "organization": {
        "id": 92,
        "domainClass": "com.campuscardtools.myphotoid.Organization",
        "name": "Test Org.",
        "isPaid": true,
        "termsOfService": null,
        "photoRequirements": [...],
        "customFields": [
            {listIndex": 3,
                "namehidden": "First Name"false
            },
            {
                "nameid": "Last437,
Name"             }   "uniqueName":      ],
 "Plain Background",
      "customCssUrl": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",         "useEmailAsUsernamerequirement": true,"Should be taken against a plain, light   "usePersonIdentifier": true,background",
         "personIdentifierLabel": "ID Number",     "listIndex": 1,
  "downloadStrategy": {             "idhidden": "EXTERNAL",false
            "name": "External Application"}
          }],
        "downloadLabelcustomFields": [
 "Download Photos",         "photoDimensions": {
                "classname": "com.campuscardtools.myphotoid.PhotoDimensions",Notes"
            }
   "id": 3,    ],
        "descriptioncustomCssUrl": "200:200",
   https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
        "heightlogoutUrl": 200null,
 
          "widthuseEmailAsUsername": 200true,
        }"usePersonIdentifier": true,
        "preventMultiplePhotospersonIdentifierLabel": "ID falseNumber",
        "approvalsPerDaydownloadStrategy": {
   0,         "approvalsMadeTodayid": 0"EXTERNAL",
 
      "canApproveMorePhotosToday": true,         "emailReplyToname": "Hello From CloudCard <hello@cloudcardtools.com>",External Application"
        "helperBotDelay": 1000},
        "additionalPhotoTypesdownloadLabel": ["Download Photos",
        "photoDimensions": {
  {          "class": "com.campuscardtools.myphotoid.PhotoDimensions",
     "errors": {        "id": 3,
            "errorsdescription": []
"200:200 (1:1)",
               }"height": 200,
                "namewidth": "Government200
Issued ID",        },
        "notBoundpreventMultiplePhotos": false,
   
            "promptapprovalsPerDay": 0,
"Please submit a photo of your government issued ID.","approvalsMadeToday": 0,
        "canApproveMorePhotosToday": true,
        "requiredemailReplyTo": false"Hello From CloudCard <hello@cloudcardtools.com>",
        "helperBotDelay": 1000,
}        "additionalPhotoTypes": []
    },
    "passwordExpired": false,
    "passwordResetRequired": false,
    "readOnly": false,
    "unsubscribe": false,
    "username": "director@sharptop.cojohn.arnold+rrtest@gmail.com"
}