eQuipAPI

<back to all web services

CreateUser

Creates a new user. Requires a valid service principal Api key to authorize the caller to complete this request.

The following routes are available for this service:
POST/usersCreates a new user.
CreateUser Parameters:
NameParameterData TypeRequiredDescription
ServicePrincipalApiKeybodyGuidYesThe Api key that authorizes the caller to complete the request. Contact your eQuip admin.
UserNamebodystringYesUser login.
UserFullNamebodystringYesUser full name.
IsActivebodybooleanNoSpecifies whether the user can log in; defaults to false.
EmailAddressbodystringYesUser email address.
PhoneNumberbodystringNoUser phone number.
UserRolebodystringYesThe role assigned to the user.
SiteScopesbodyList<int>YesList of site Ids authorized for this user. See Api: FindSites.
AssetCategoryScopesbodyList<int>NoList of asset category Ids authorized for this user. See Api: FindAssetCategories.
LocationCategoryScopesbodyList<int>NoList of location category Ids authorized for this user. See Api: FindLocationCategories.
PeopleCategoryScopesbodyList<int>NoList of people category Ids authorized for this user. See Api: FindPeopleCategories.
DepartmentScopesbodyList<int>NoList of department Ids authorized for this user. See Api: FindDepartments.
ContractScopesbodyList<int>NoList of contract Ids authorized for this user. See Api: GetContract.
UserDto Parameters:
NameParameterData TypeRequiredDescription
UserUuidbodyGuidNoUser Internal ID of User record
UserIDbodyInt32NoUser ID of User record
UserNamebodystringNoUser Name using which user will be logged in
UserFullNamebodystringNoUser full name
ActivebodybooleanNoActive or InActive
EmailAddressbodystringNoUser email address
PhoneNumberbodystringNoUser phone number
RolebodystringNoUser Role
LastLoginDatebodyDateTime?NoUser's last Login date. Last Login Date can be null, If user's never logged in.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/CreateUser HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: application/xml
Content-Length: length

<CreateUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <AssetCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </AssetCategoryScopes>
  <ContractScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ContractScopes>
  <DepartmentScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DepartmentScopes>
  <EmailAddress>String</EmailAddress>
  <IsActive>false</IsActive>
  <LocationCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LocationCategoryScopes>
  <PeopleCategoryScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PeopleCategoryScopes>
  <PhoneNumber>String</PhoneNumber>
  <ServicePrincipalApiKey>00000000-0000-0000-0000-000000000000</ServicePrincipalApiKey>
  <SiteScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SiteScopes>
  <UserFullName>String</UserFullName>
  <UserName>String</UserName>
  <UserRole>String</UserRole>
</CreateUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <Active>false</Active>
  <EmailAddress>String</EmailAddress>
  <LastLoginDate>0001-01-01T00:00:00</LastLoginDate>
  <PhoneNumber>String</PhoneNumber>
  <Role>String</Role>
  <UserFullName>String</UserFullName>
  <UserID>0</UserID>
  <UserName>String</UserName>
  <UserUuid>00000000-0000-0000-0000-000000000000</UserUuid>
</UserDto>