Create a Person

This endpoint is currently (Jan 2019) undergoing some significant performance improvements and is likely to change, so please contact support@onlinephotosubmission.com for more information.

The ability to update a person via this endpoint has been deprecated. If you need to update a person, please refer to the Update a Person endpoint.

This Example Project demonstrates how to consume an older version this API endpoint within a Java project.

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

URI: https://api.onlinephotosubmission.com/api/people

HTTP Method: POST

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

Optional URL Parameters:

sendInvitation=[true|false] default is true If sendInvitation is false, cardholders will not receive an email invitation.
If sendInvitation is true (or not specified), an email invitation will be sent to the cardholder.

Example HTTP Request Body - Email Only

{
  "email": "jon.doe@foo.edu"
}

Example HTTP Request Body - Using option "identifier" field to set ID Number

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123"
}

Example HTTP Request Body - Set the user's custom fields

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "customFields":{ 
    "Last_Name":"Card",
    "First Name":"Carry A",
    "Upload Date":"2017 - 06 - 22 11:17AM",
    "Batch":"1"
  }
}

Current Response (Likely to Change Soon)

201 created
{ 

   "accountExpired":false,
   "accountLocked":false,
   "activatedDate":null,
   "authorities":[ 
      { 
         "class":"com.campuscardtools.myphotoid.Role",
         "id":3,
         "authority":"ROLE_CARDHOLDER"
      }
   ],
   "currentPhoto":null,
   "customFields":{ 
      "Upload Date":{ 
         "class":"com.campuscardtools.myphotoid.CustomFieldValue",
         "id":3541,
         "customField":{ 
            "class":"com.campuscardtools.myphotoid.CustomField",
            "id":34
         },
         "lastUpdated":"2017-06-26T20:00:47Z",
         "person":{ 
            "class":"com.campuscardtools.myphotoid.Person",
            "id":123
         },
         "value":"2017 - 06 - 22 11:17AM"
      },
      "Last Name":null,
      "First Name":{ 
         "class":"com.campuscardtools.myphotoid.CustomFieldValue",
         "id":3540,
         "customField":{ 
            "class":"com.campuscardtools.myphotoid.CustomField",
            "id":31
         },
         "lastUpdated":"2017-06-26T20:00:47Z",
         "person":{ 
            "class":"com.campuscardtools.myphotoid.Person",
            "id":123
         },
         "value":"Carry A"
      },
      "Batch":{ 
         "class":"com.campuscardtools.myphotoid.CustomFieldValue",
         "id":3542,
         "customField":{ 
            "class":"com.campuscardtools.myphotoid.CustomField",
            "id":33
         },
         "lastUpdated":"2017-06-26T20:00:47Z",
         "person":{ 
            "class":"com.campuscardtools.myphotoid.Person",
            "id":123
         },
         "value":"1"
      }
   },
   "dateTermsAccepted":null,
   "domainClass":"com.campuscardtools.myphotoid.Person",
   "email":"john.doe@foo.edu",
   "enabled":true,
   "id":123,
   "identifier":"ABC123",
   "latestPhoto": null,
   "organization":{ ... },
   "passwordExpired":false,
   "passwordResetRequired":false,
   "readOnly":false,
   "username":"john.doe@foo.edu"
}