PUT AgvanceUser/PutAgvanceUser

Updates an Agvance User

Request Information

URI Parameters

Body Parameters

Object used to update an existing User in the database.

Name	Description	Type	Additional Information
UserGuid	The Globally Unique Identifier for the User. When populated will be the user that is edited.	globally unique identifier	(Hexadecimal 8-4-4-4-12)
Id	The short identifier that is used as a reference for the user throughout Agvance. Required if UserGuid is not provided.	string	Max length: 3
UserRoleId	The id that is used to connect an Agvance User to a Security Role. A list can be obtained from AgvanceUserRole/GetAgvanceUserRole	integer	Required
Inactive	The Status to change the user to.	boolean	Required Must be 0, 1, True, or False

Request Formats

application/json, text/json

Sample:

{
  "UserGuid": "f06a02f4-9514-4378-8c41-3649155d666b",
  "Id": "sample string 4",
  "UserRoleId": 5,
  "Inactive": true
}

application/xml, text/xml

Sample:

<ClsUser.ClsUserUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.User">
  <Id>sample string 4</Id>
  <Inactive>true</Inactive>
  <UserGuid>f06a02f4-9514-4378-8c41-3649155d666b</UserGuid>
  <UserRoleId>5</UserRoleId>
</ClsUser.ClsUserUpdate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsUserUpdate'.

Response Information

Resource Description

Updates an Agvance User

AgvanceUser

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
Count	Number of results returned.	string
Users	List of Properties and Values returned for each Agvance User that matches the request.	Collection of ClsUser

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "Users": [
    {
      "UserGuid": "c087d67d-2f37-407b-8f22-50186c1cbc17",
      "Id": "sample string 6",
      "FirstName": "sample string 7",
      "LastName": "sample string 8",
      "LoginName": "sample string 9",
      "WindowsLoginId": "sample string 10",
      "UserRoleId": 11,
      "UserRole": "sample string 12",
      "Inactive": true,
      "LocationAccessTypes": [
        {
          "AccessType": 0,
          "AvailableLocations": [
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            },
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            }
          ]
        },
        {
          "AccessType": 0,
          "AvailableLocations": [
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            },
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            }
          ]
        }
      ],
      "AppSecurity": [
        {
          "Application": 0,
          "PreferenceName": "sample string 4",
          "PreferenceValue": true
        },
        {
          "Application": 0,
          "PreferenceName": "sample string 4",
          "PreferenceValue": true
        }
      ],
      "RestrictedLocationCosts": [
        {
          "LocationGuid": "aea8779b-7d93-47b7-a9ab-7cf913806e12",
          "LocationId": "sample string 3",
          "LocationName": "sample string 4"
        },
        {
          "LocationGuid": "aea8779b-7d93-47b7-a9ab-7cf913806e12",
          "LocationId": "sample string 3",
          "LocationName": "sample string 4"
        }
      ]
    },
    {
      "UserGuid": "c087d67d-2f37-407b-8f22-50186c1cbc17",
      "Id": "sample string 6",
      "FirstName": "sample string 7",
      "LastName": "sample string 8",
      "LoginName": "sample string 9",
      "WindowsLoginId": "sample string 10",
      "UserRoleId": 11,
      "UserRole": "sample string 12",
      "Inactive": true,
      "LocationAccessTypes": [
        {
          "AccessType": 0,
          "AvailableLocations": [
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            },
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            }
          ]
        },
        {
          "AccessType": 0,
          "AvailableLocations": [
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            },
            {
              "LocationGuid": "6289c54e-ff32-4ee7-87e4-c551a5d42d28",
              "LocationId": "sample string 2",
              "LocationName": "sample string 3",
              "Inactive": true
            }
          ]
        }
      ],
      "AppSecurity": [
        {
          "Application": 0,
          "PreferenceName": "sample string 4",
          "PreferenceValue": true
        },
        {
          "Application": 0,
          "PreferenceName": "sample string 4",
          "PreferenceValue": true
        }
      ],
      "RestrictedLocationCosts": [
        {
          "LocationGuid": "aea8779b-7d93-47b7-a9ab-7cf913806e12",
          "LocationId": "sample string 3",
          "LocationName": "sample string 4"
        },
        {
          "LocationGuid": "aea8779b-7d93-47b7-a9ab-7cf913806e12",
          "LocationId": "sample string 3",
          "LocationName": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvanceUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.User">
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.User">
    <d2p1:ClsUser>
      <d2p1:AppSecurity>
        <d2p1:ClsUser.ClsUserAppSecurity>
          <d2p1:Application>Warehouse</d2p1:Application>
          <d2p1:PreferenceName>sample string 4</d2p1:PreferenceName>
          <d2p1:PreferenceValue>true</d2p1:PreferenceValue>
        </d2p1:ClsUser.ClsUserAppSecurity>
        <d2p1:ClsUser.ClsUserAppSecurity>
          <d2p1:Application>Warehouse</d2p1:Application>
          <d2p1:PreferenceName>sample string 4</d2p1:PreferenceName>
          <d2p1:PreferenceValue>true</d2p1:PreferenceValue>
        </d2p1:ClsUser.ClsUserAppSecurity>
      </d2p1:AppSecurity>
      <d2p1:FirstName>sample string 7</d2p1:FirstName>
      <d2p1:Id>sample string 6</d2p1:Id>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:LastName>sample string 8</d2p1:LastName>
      <d2p1:LocationAccessTypes>
        <d2p1:ClsUser.ClsUserLocationAccessType>
          <d2p1:AccessType>Login</d2p1:AccessType>
          <d2p1:AvailableLocations>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
          </d2p1:AvailableLocations>
        </d2p1:ClsUser.ClsUserLocationAccessType>
        <d2p1:ClsUser.ClsUserLocationAccessType>
          <d2p1:AccessType>Login</d2p1:AccessType>
          <d2p1:AvailableLocations>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
          </d2p1:AvailableLocations>
        </d2p1:ClsUser.ClsUserLocationAccessType>
      </d2p1:LocationAccessTypes>
      <d2p1:LoginName>sample string 9</d2p1:LoginName>
      <d2p1:RestrictedLocationCosts>
        <d2p1:ClsUser.ClsUserLocationCostRestriction>
          <d2p1:LocationGuid>aea8779b-7d93-47b7-a9ab-7cf913806e12</d2p1:LocationGuid>
          <d2p1:LocationId>sample string 3</d2p1:LocationId>
          <d2p1:LocationName>sample string 4</d2p1:LocationName>
        </d2p1:ClsUser.ClsUserLocationCostRestriction>
        <d2p1:ClsUser.ClsUserLocationCostRestriction>
          <d2p1:LocationGuid>aea8779b-7d93-47b7-a9ab-7cf913806e12</d2p1:LocationGuid>
          <d2p1:LocationId>sample string 3</d2p1:LocationId>
          <d2p1:LocationName>sample string 4</d2p1:LocationName>
        </d2p1:ClsUser.ClsUserLocationCostRestriction>
      </d2p1:RestrictedLocationCosts>
      <d2p1:UserGuid>c087d67d-2f37-407b-8f22-50186c1cbc17</d2p1:UserGuid>
      <d2p1:UserRole>sample string 12</d2p1:UserRole>
      <d2p1:UserRoleId>11</d2p1:UserRoleId>
      <d2p1:WindowsLoginId>sample string 10</d2p1:WindowsLoginId>
    </d2p1:ClsUser>
    <d2p1:ClsUser>
      <d2p1:AppSecurity>
        <d2p1:ClsUser.ClsUserAppSecurity>
          <d2p1:Application>Warehouse</d2p1:Application>
          <d2p1:PreferenceName>sample string 4</d2p1:PreferenceName>
          <d2p1:PreferenceValue>true</d2p1:PreferenceValue>
        </d2p1:ClsUser.ClsUserAppSecurity>
        <d2p1:ClsUser.ClsUserAppSecurity>
          <d2p1:Application>Warehouse</d2p1:Application>
          <d2p1:PreferenceName>sample string 4</d2p1:PreferenceName>
          <d2p1:PreferenceValue>true</d2p1:PreferenceValue>
        </d2p1:ClsUser.ClsUserAppSecurity>
      </d2p1:AppSecurity>
      <d2p1:FirstName>sample string 7</d2p1:FirstName>
      <d2p1:Id>sample string 6</d2p1:Id>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:LastName>sample string 8</d2p1:LastName>
      <d2p1:LocationAccessTypes>
        <d2p1:ClsUser.ClsUserLocationAccessType>
          <d2p1:AccessType>Login</d2p1:AccessType>
          <d2p1:AvailableLocations>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
          </d2p1:AvailableLocations>
        </d2p1:ClsUser.ClsUserLocationAccessType>
        <d2p1:ClsUser.ClsUserLocationAccessType>
          <d2p1:AccessType>Login</d2p1:AccessType>
          <d2p1:AvailableLocations>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
            <d2p1:ClsUser.ClsUserLocationAccess>
              <d2p1:Inactive>true</d2p1:Inactive>
              <d2p1:LocationGuid>6289c54e-ff32-4ee7-87e4-c551a5d42d28</d2p1:LocationGuid>
              <d2p1:LocationId>sample string 2</d2p1:LocationId>
              <d2p1:LocationName>sample string 3</d2p1:LocationName>
            </d2p1:ClsUser.ClsUserLocationAccess>
          </d2p1:AvailableLocations>
        </d2p1:ClsUser.ClsUserLocationAccessType>
      </d2p1:LocationAccessTypes>
      <d2p1:LoginName>sample string 9</d2p1:LoginName>
      <d2p1:RestrictedLocationCosts>
        <d2p1:ClsUser.ClsUserLocationCostRestriction>
          <d2p1:LocationGuid>aea8779b-7d93-47b7-a9ab-7cf913806e12</d2p1:LocationGuid>
          <d2p1:LocationId>sample string 3</d2p1:LocationId>
          <d2p1:LocationName>sample string 4</d2p1:LocationName>
        </d2p1:ClsUser.ClsUserLocationCostRestriction>
        <d2p1:ClsUser.ClsUserLocationCostRestriction>
          <d2p1:LocationGuid>aea8779b-7d93-47b7-a9ab-7cf913806e12</d2p1:LocationGuid>
          <d2p1:LocationId>sample string 3</d2p1:LocationId>
          <d2p1:LocationName>sample string 4</d2p1:LocationName>
        </d2p1:ClsUser.ClsUserLocationCostRestriction>
      </d2p1:RestrictedLocationCosts>
      <d2p1:UserGuid>c087d67d-2f37-407b-8f22-50186c1cbc17</d2p1:UserGuid>
      <d2p1:UserRole>sample string 12</d2p1:UserRole>
      <d2p1:UserRoleId>11</d2p1:UserRoleId>
      <d2p1:WindowsLoginId>sample string 10</d2p1:WindowsLoginId>
    </d2p1:ClsUser>
  </Users>
</AgvanceUser>