Documentation
Start typing to search…

updatePersonProfile Sample API Call

This guide demonstrates a complete workflow for updating person profile information in ScholarOne Manuscripts using the updatePersonProfile API. The example shows how to retrieve existing profile data using getPersonInfoBasic and then update specific fields using updatePersonProfile.

Workflow Overview

The typical workflow for updating a person's profile involves two steps:

  1. Retrieve Current Profile Data - Use the getPersonInfoBasic or getPersonInfoFull API to fetch the current profile information
  2. Update Profile Fields - Use the updatePersonProfile API to modify specific fields while preserving other data

This two-step approach ensures that you have the most current data before making updates and helps prevent unintended data loss.

Step 1: Retrieve Current Profile Data

API Call: getPersonInfoBasic

First, we retrieve the current profile information for the person we want to update. This allows us to see what data currently exists and identify which fields need modification.

Request URL:
https://mc-api.manuscriptcentral.com/api/s1m/v3/person/basic/personids/search?site_name=salesdemoplus&ids='15003305'&_type=xml

Response:

The API returns the current profile information for person ID 15003305:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
    <status>SUCCESS</status>
    <callId>6c2e6f14-f49e-4d6d-9d8f-ac0ee8b781eb</callId>
    <result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="personInfoBasicByPersonIdOutput">
        <accountCreatedDate>2009-02-12T09:20:00Z</accountCreatedDate>
        <activeFlag>1</activeFlag>
        <externalUserId>johnK1</externalUserId>
        <firstName>Michael</firstName>
        <lastName>Scott</lastName>
        <localeId>1</localeId>
        <membershipStatus>Active</membershipStatus>
        <orcidId>0000-0003-1289-3494</orcidId>
        <orcidAccessToken>f8c0990a-a40f-4012-9b85-b9a6f46360a3</orcidAccessToken>
        <orcidValidation>true</orcidValidation>
        <personId>15003305</personId>
        <primaryEmailAddress>[email protected]</primaryEmailAddress>
        <ssoStatusId>3</ssoStatusId>
        <ssoStatusName>ELIGIBLE-LINKED</ssoStatusName>
        <userId>allan.author</userId>
    </result>
</Response>

Step 2: Update the Person Profile

Now that we have confirmed the current profile data, we'll update the profile to:

  1. Add a middle name
  2. Update the email address to match the user's actual name
  3. Add institutional affiliation information
  4. Add complete address details
  5. Add a phone number
  6. Preserve the existing ORCID information

API Call: updatePersonProfile

Request URL:
https://mc-api.manuscriptcentral.com/api/s1m/v3/person/full/update?site_name=salesdemoplus

Request Body (JSON):

{
  "input": {
    "personId": "15003305",
    "externalUserId": "johnK1",
    "firstName": "Michael",
    "middleName": "Gary",
    "lastName": "Scott",
    "email": "[email protected]",
    "primaryInstitution": "Paper Company",
    "institutionId": "45678",
    "department": "Sales Department",
    "address1": "1725 Slough Avenue",
    "address2": "Suite 200",
    "address3": "",
    "city": "Scranton",
    "country": "US",
    "state": "PA",
    "postalCode": "18503",
    "phone": "+1-570-555-0123",
    "ORCIDId": "0000-0003-1289-3494",
    "ORCIDDatetimeValidated": "01/15/2025 10:30:00",
    "ORCIDAccessToken": "f8c0990a-a40f-4012-9b85-b9a6f46360a3"
  }
}

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
    <status>SUCCESS</status>
    <callId>56854b6e-4ab0-4354-b722-2b73811cba18</callId>
</Response>

Step 3: Verify the Update

After successfully updating the profile, it's a good practice to verify that the changes were applied correctly by calling the getPersonInfoFull API (which includes extended profile fields).

Request URL:

https://mc-api.manuscriptcentral.com/api/s1m/v8/person/full/personid/search?site_name=salesdemoplus&ids='15003305'


Updated about 1 month ago

What’s Next