POST {clientId}/Config/Users

Add Users.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required

Body Parameters

Collection of Users to submit

Collection of ConfigUser

Name	Description	Type	Additional information
UserName		string	Required Min length: 1
FirstName		string	Required Min length: 1
LastName		string	Required Min length: 1
PersonTypeNbr		integer	Required Range: inclusive between 1 and 5
Email		string	Required Min length: 1
UserGroups		Collection of ConfigUserGroupIDOnly	Required
SourceGroupID		string	Required Min length: 1
DefaultLandingPage	Used by Profile accounts to route users to a specific page after logging in. Options include Dashboard, ProfileSearch, DataExport	string	None.
DefaultLandingPageTypeNbr		integer	None.
Phone		string	None.
Description		string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Phone": "sample string 1",
    "Description": "sample string 2",
    "UserName": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "PersonTypeNbr": 4,
    "Email": "sample string 5",
    "UserGroups": [
      {
        "UserGroupID": "sample string 1"
      }
    ],
    "SourceGroupID": "sample string 6",
    "DefaultLandingPage": "sample string 7",
    "DefaultLandingPageTypeNbr": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfConfigUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigUser>
    <DefaultLandingPage>sample string 7</DefaultLandingPage>
    <DefaultLandingPageTypeNbr>1</DefaultLandingPageTypeNbr>
    <Description>sample string 2</Description>
    <Email>sample string 5</Email>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <PersonTypeNbr>4</PersonTypeNbr>
    <Phone>sample string 1</Phone>
    <SourceGroupID>sample string 6</SourceGroupID>
    <UserGroups>
      <ConfigUserGroupIDOnly>
        <UserGroupID>sample string 1</UserGroupID>
      </ConfigUserGroupIDOnly>
    </UserGroups>
    <UserName>sample string 1</UserName>
  </ConfigUser>
</ArrayOfConfigUser>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)
BadRequest (400)
NotFound (404)

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.