POST {lang}/User/UpsertUser/{format}/{interfaceid}/{orgid}

create and update user

Request Information

URI Parameters

Name	Type	Additional information
format	string	Required
interfaceid	integer	Required
orgid	integer	Required
lang	string	None.

Body Parameters

UserUpsertRequestData

Name	Description	Type	Additional information
User		MobileUser	None.
UpdatePolicy		UpdatePolicy	None.
DepartmentsUpdatePolicy		ArrayUpdatePolicy	None.
ShouldSendInstallationSms		boolean	None.
ShouldAddAsCandidate		boolean	None.
Locale	Language for SMS/Email installation guide. Example value: en-us	string	None.
ContactPersons		Collection of ContactPersonItem	None.
UserId		integer	None.
CreateNewDepartments	If true, create new departments if DepartmentNames does not exist	boolean	None.
DisableUpdateByUserName		boolean	None.
IncludePolygonTagCountsOnResponse		boolean	None.
updatedPasswordFromMobile		boolean	None.

Request Formats

application/json; charset=utf-8, application/json, application/vnd.google-earth.kml+xml, text/plain, image/png, text/csv, application/x-www-form-urlencoded

Sample:

{
  "User": null,
  "UpdatePolicy": 0,
  "DepartmentsUpdatePolicy": 0,
  "ShouldSendInstallationSms": true,
  "ShouldAddAsCandidate": true,
  "Locale": "sample string 3",
  "ContactPersons": [
    {
      "ID": 1,
      "ContactKindID": 2,
      "MobileUserID": 1,
      "Email": "sample string 3",
      "AreaCode": "sample string 4",
      "PhoneNumber": "sample string 5",
      "FirstName": "sample string 7",
      "LastName": "sample string 9",
      "Description": "sample string 11",
      "Link": "sample string 12",
      "ContactKindDisplayName": null,
      "UserName": "sample string 13",
      "AssetId": 1
    },
    {
      "ID": 1,
      "ContactKindID": 2,
      "MobileUserID": 1,
      "Email": "sample string 3",
      "AreaCode": "sample string 4",
      "PhoneNumber": "sample string 5",
      "FirstName": "sample string 7",
      "LastName": "sample string 9",
      "Description": "sample string 11",
      "Link": "sample string 12",
      "ContactKindDisplayName": null,
      "UserName": "sample string 13",
      "AssetId": 1
    }
  ],
  "UserId": 1,
  "CreateNewDepartments": true,
  "DisableUpdateByUserName": true,
  "IncludePolygonTagCountsOnResponse": true,
  "updatedPasswordFromMobile": true
}

application/xml; charset=utf-8, application/xml

Sample:

<UserUpsertRequestData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UpdatePolicy>FullUpdate</UpdatePolicy>
  <DepartmentsUpdatePolicy>Override</DepartmentsUpdatePolicy>
  <ShouldSendInstallationSms>true</ShouldSendInstallationSms>
  <ShouldAddAsCandidate>true</ShouldAddAsCandidate>
  <Locale>sample string 3</Locale>
  <ContactPersons>
    <ContactPersonItem>
      <ID>1</ID>
      <ContactKindID>2</ContactKindID>
      <MobileUserID>1</MobileUserID>
      <Email>sample string 3</Email>
      <AreaCode>sample string 4</AreaCode>
      <PhoneNumber>sample string 5</PhoneNumber>
      <FirstName>sample string 7</FirstName>
      <LastName>sample string 9</LastName>
      <Description>sample string 11</Description>
      <Link>sample string 12</Link>
      <UserName>sample string 13</UserName>
      <AssetId>1</AssetId>
    </ContactPersonItem>
    <ContactPersonItem>
      <ID>1</ID>
      <ContactKindID>2</ContactKindID>
      <MobileUserID>1</MobileUserID>
      <Email>sample string 3</Email>
      <AreaCode>sample string 4</AreaCode>
      <PhoneNumber>sample string 5</PhoneNumber>
      <FirstName>sample string 7</FirstName>
      <LastName>sample string 9</LastName>
      <Description>sample string 11</Description>
      <Link>sample string 12</Link>
      <UserName>sample string 13</UserName>
      <AssetId>1</AssetId>
    </ContactPersonItem>
  </ContactPersons>
  <UserId>1</UserId>
  <CreateNewDepartments>true</CreateNewDepartments>
  <DisableUpdateByUserName>true</DisableUpdateByUserName>
  <IncludePolygonTagCountsOnResponse>true</IncludePolygonTagCountsOnResponse>
  <updatedPasswordFromMobile>true</updatedPasswordFromMobile>
</UserUpsertRequestData>

Response Information

Resource Description

UserUpsertResponseData

Name	Type	Additional information
UserId	integer	None.
MobileUser	MobileUser	None.
ErrorId	UserUpsertErrorType	None.
MissingLicensesNames	string	None.
ErrorDesc	string	None.
PasswordValidationErrorId	ResetErrorType	None.

Response Formats

application/json; charset=utf-8, application/json, application/vnd.google-earth.kml+xml, text/plain, image/png, text/csv, application/x-www-form-urlencoded

Sample:

{
  "UserId": 1,
  "MobileUser": null,
  "ErrorId": 1,
  "MissingLicensesNames": "sample string 2",
  "ErrorDesc": "sample string 3",
  "PasswordValidationErrorId": 1
}

application/xml; charset=utf-8, application/xml

Sample:

<UserUpsertResponseData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserId>1</UserId>
  <ErrorId>License</ErrorId>
  <MissingLicensesNames>sample string 2</MissingLicensesNames>
  <ErrorDesc>sample string 3</ErrorDesc>
  <PasswordValidationErrorId>General</PasswordValidationErrorId>
</UserUpsertResponseData>