Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Update Administrative Access Details

After you have created your administrative access details (POST /{custid}/adminaccess), you can update your administrative access details. Administrative access details are defined by an administrative access details object. The administrative access data elements can be updated. The update will yield the updated administrative access details object, the administrative access id, any errors and a success flag.

To Update Administrative Access Details (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The administrative access id for the administrative access details that you would like to update.
  • The updated administrative access details object.

Request

PUT  https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess/ID
Body Request Parameter

{
  "accessConfirmedStatus": "Not Started",
  "accessModel": "Rolling 2 years",
  "accessModelNotes": "Sample Access Model Notes",
  "accessRestrictionNotes": "Sample Access Restriction Notes",
  "adminAccessInterface": "Sample Name of Interface",
  "adminAccessInterfaceProvider": "Sample interface provider",
  "athensAuthenticationSupported": "Yes",
  "authenticationNotes": "Sample authentication notes.",
  "customerCanChoosePassword": "Yes",
  "dateIPRegistered": "2000-10-10T10:10:10.000Z",
  "extensionObject": {
    "objectDescription": "Sample Description Updated",
    "objectType": "admin_access",
    "status": "active"
  },
  "hostID": "10160",
  "hostURL": "http://hostname.com",
  "ipAddressNotes": "Sample IP address notes.",
  "ipAddresses": "172.16.254.1",
  "ipAuthenticationSupported": "Yes",
  "otherStatusKeyValue": {
    "status1": "value1",
    "status2": "value2",
    "status3": "value3"
  },
  "otherStringKeyValue": {
    "string1": "value1",
    "string2": "value2",
    "string3": "value3"
  },
  "otherYesNoKeyValue": {
    "yesNo1": "yesNo1",
    "yesNo2": "yesNo2",
    "yesNo3": "yesNo3"
  },
  "passwordSharingAllowed": "Yes",
  "proxyAllowed": "No",
  "registrationID": "121234",
  "registrationInstructions": "Sample registration instructions.",
  "registrationStatus": "In Progress",
  "registrationURL": "http://hostname.com",
  "remoteAccessAllowed": "No",
  "shibbolethAuthenticationSupported": "No",
  "usernamePasswordAuthenticationSupported": "Yes"
}


Response

200 OK

{
  "adminAccessId": "79257642-5f9b-4316-82bc-778e3bc1e223",
  "errors": [],
  "adminAccess": {
    "extensionObject": {
      "id": "79257642-5f9b-4316-82bc-778e3bc1e223",
      "customerId": "123355",
      "status": "active",
      "objectType": "admin_access",
      "objectDescription": "Sample Description Updated"
    },
    "dateCreated": "2019-01-17T19:59:32.000Z",
    "dateLastUpdated": "2019-01-17T20:03:03.365Z",
    "accessModel": "Rolling 2 years",
    "accessModelNotes": "Sample Access Model Notes",
    "accessRestrictionNotes": "Sample Access Restriction Notes",
    "remoteAccessAllowed": "No",
    "hostURL": "http://hostname.com",
    "hostID": "10160",
    "registrationURL": "http://hostname.com",
    "registrationInstructions": "Sample registration instructions.",
    "registrationID": "121234",
    "ipAddressNotes": "Sample IP address notes.",
    "adminAccessInterface": "Sample Name of Interface",
    "adminAccessInterfaceProvider": "Sample interface provider",
    "ipAuthenticationSupported": "Yes",
    "proxyAllowed": "No",
    "usernamePasswordAuthenticationSupported": "Yes",
    "athensAuthenticationSupported": "Yes",
    "shibbolethAuthenticationSupported": "No",
    "customerCanChoosePassword": "Yes",
    "passwordSharingAllowed": "Yes",
    "authenticationNotes": "Sample authentication notes.",
    "ipAddresses": "172.16.254.1",
    "registrationStatus": "In Progress",
    "accessConfirmedStatus": "Not Started",
    "dateIPRegistered": "2000-10-10T10:10:10.000Z",
    "otherStatusKeyValue": {
      "status1": "value1",
      "status2": "value2",
      "status3": "value3"
    },
    "otherYesNoKeyValue": {
      "yesNo3": "yesNo3",
      "yesNo2": "yesNo2",
      "yesNo1": "yesNo1"
    },
    "otherStringKeyValue": {
      "string3": "value3",
      "string1": "value1",
      "string2": "value2"
    }
  },
  "successful": true
}



For more information on the PUT update administrative access details by id resource, please refer to our interactive or service reference documentation.