Logo
Submit a request
Follow

Users

Adding a User

URL

https://app.bluefolder.com/api/2.0/users/add.aspx

Request

<request>
  <userAdd>
    <allowApi></allowApi>
    <defaultLaborRateId></defaultLaborRateId>
    <displayName></displayName>
    <emailAddress></emailAddress>
    <firstname></firstname>
    <inheritAddressFromOffice></inheritAddressFromOffice>
    <jobTitle></jobTitle>
    <lastname></lastname>
    <link1Name></link1Name>
    <link1Url></link1Url>
    <link2Name></link2Name>
    <link2Url></link2Url>
    <officeId></officeId>
    <password></password>
    <phone></phone>
    <phoneFax></phoneFax>
    <phoneMobile></phoneMobile>
    <roles>
        <role></role>
        ...
    </roles>
    <sendScheduleChangesAsICal></sendScheduleChangesAsICal>
    <sendSystemNotifications></sendSystemNotifications>
    <timeObserveDst></timeObserveDst>
    <timeZoneOffset></timeZoneOffset>
    <username></username>
    <userType></userType>
    <workAddressCity></workAddressCity>
    <workAddressCountry></workAddressCountry>
    <workAddressPostalCode></workAddressPostalCode>
    <workAddressState></workAddressState>
    <workAddressStreetAddress></workAddressStreetAddress>
    <workHoursStart></workHoursStart>
    <workHoursEnd></workHoursEnd>
  </userAdd>
</request>
            
  • allowApi - boolean
  • defaultLaborRateId - numeric, must match an existing labor rate Id from your item list
  • displayName - (required, unique) string (100 char limit)
  • emailAddress - (required) string (255 char limit)
  • firstName - (required) string (25 char limit)
  • inheritAddressFromOffice - boolean
  • jobTitle - string (50 char limit)
  • lastName - (required) string (25 char limit)
  • link1Name - string (50 char limit)
  • link1Url - string (255 char limit)
  • link2Name - string (50 char limit)
  • link2Url - string (255 char limit)
  • officeId - numeric, must match an existing office Id from your office list
  • password - (required if the userType is standard) string
  • phone - string (30 char limit)
  • phoneFax - string (30 char limit)
  • phoneMobile - string (30 char limit)
  • roles - (required) string, list of roles, (administrator, bookkeeper, sales, service manager, scheduler, lead technician, technician, subcontractor)
  • sendScheduleChangesAsICal - boolean
  • sendSystemNotifications - boolean
  • textMessageAddress - string (255 char limit)
  • timeObserveDst - boolean
  • timeZoneOffset - numeric, must be a valid time zone offset
  • userName - (required if the userType is anything other than nologin, unique) string (255 char limit)
  • userType - (required) string (standard, nologin)
  • workAddressCity - string (25 char limit)
  • workAddressCountry - string (25 char limit)
  • workAddressPostalCode - string (10 char limit)
  • workAddressState - string (25 char limit)
  • workAddressStreetAddress - string (250 char limit)
  • workHoursStart - time
  • workHoursEnd - time

Response

<response status="ok">
  <userId>xxxxxx</userId>
</response>
            

Editing a User

URL

https://app.bluefolder.com/api/2.0/users/edit.aspx

Request

<request>
  <userEdit>
    <defaultLaborRateId></defaultLaborRateId>
    <displayName></displayName>
    <emailAddress></emailAddress>
    <firstName></firstName>
    <inheritAddressFromOffice></inheritAddressFromOffice>
    <jobTitle></jobTitle>
    <lastName></lastName>
    <link1Name></link1Name>
    <link1Url></link1Url>
    <link2Name></link2Name>
    <link2Url></link2Url>
    <officeId></officeId>
    <phone></phone>
    <phoneFax></phoneFax>
    <phoneMobile></phoneMobile>
    <sendScheduleChangesAsICal></sendScheduleChangesAsICal>
    <sendSystemNotifications></sendSystemNotifications>
    <textMessageAddress></textMessageAddress>
    <timeObserveDst></timeObserveDst>
    <timeZoneOffset></timeZoneOffset>
    <userId></userId>
    <username></username>
    <workAddressCity></workAddressCity>
    <workAddressCountry></workAddressCountry>
    <workAddressPostalCode></workAddressPostalCode>
    <workAddressState></workAddressState>
    <workAddressStreetAddress></workAddressStreetAddress>
    <workHoursStart></workHoursStart>
    <workHoursEnd></workHoursEnd>
  </userEdit>
</request>
            
  • defaultLaborRateId - numeric, must match an existing labor rate Id from your item list
  • displayName - (required, unique) string (100 char limit)
  • emailAddress - (required) string (255 char limit)
  • firstName - (required) string (25 char limit)
  • inheritAddressFromOffice - boolean
  • jobTitle - string (50 char limit)
  • lastName - (required) string (25 char limit)
  • link1Name - string (50 char limit)
  • link1Url - string (255 char limit)
  • link2Name - string (50 char limit)
  • link2Url - string (255 char limit)
  • officeId - numeric, must match an existing office Id from your office list
  • phone - string (30 char limit)
  • phoneFax - string (30 char limit)
  • phoneMobile - string (30 char limit)
  • sendScheduleChangesAsICal - boolean
  • sendSystemNotifications - boolean
  • textMessageAddress - string (255 char limit)
  • timeObserveDst - boolean
  • timeZoneOffset - numeric, must be a valid time zone offset
  • userId - numeric, (userId, userName, or userToken are required to identify the user being edited)
  • username - string (255 char limit)
  • workAddressCity - string (25 char limit)
  • workAddressCountry - string (25 char limit)
  • workAddressPostalCode - string (10 char limit)
  • workAddressState - string (25 char limit)
  • workAddressStreetAddress - string (250 char limit)
  • workHoursStart - time
  • workHoursEnd - time

Response

<response status="ok">
  <userId>xxxxxx</userId>
</response>
            

Retrieving a Single User

URL

https://app.bluefolder.com/api/2.0/users/get.aspx

Request

<request>
    <userId>xxxxxx</userId>
</request>
            
  • userId - (required) numeric, the Id of the user to be retrieved

Response

<?xml version='1.0'?>
<response status="ok">
  <user>
    <displayName></displayName>
    <firstName></firstName>
    <inactive></inactive>
    <lastName></lastName>
    <userId></userId>
    <userName></userName>
    <userType></userType>
    <accountOwner></accountOwner>
    <addressHome_City />
    <addressHome_Country />
    <addressHome_PostalCode />
    <addressHome_State />
    <addressHome_Street />
    <addressWork_City />
    <addressWork_Country />
    <addressWork_PostalCode />
    <addressWork_State />
    <addressWork_Street />
    <allowApi></allowApi>
    <cultureName></cultureName>
    <dateLastLogin></dateLastLogin>
    <dateTimeCreated></dateTimeCreated>
    <defaultLaborRateId></defaultLaborRateId>
    <email></email>
    <fullName></fullName>
    <jobTitle />
    <loginCount></loginCount>
    <middleName />
    <phone />
    <phoneFax />
    <phoneMobile />
    <roles>
      <role>
        <name></name>
        <customName></customName>
      </role>
    </roles>
    <sendSystemNotifications></sendSystemNotifications>
    <textMsgAddress />
    <timeObserveDST></timeObserveDST>
    <timeZoneOffset></timeZoneOffset>
    <tokenApi></tokenApi>
    <workHoursEnd></workHoursEnd>
    <workHoursStart></workHoursStart>
  </user>
</response>
            

Retrieving a List of Users

URL

https://app.bluefolder.com/api/2.0/users/list.aspx

Request

<request>
    <userList>
        <listType></listType>
    </userList>
</request>
            
Parameters: listType: either 'basic', or 'full'

Response (for 'basic' list)

<response status="ok">
       <user>
              <userId></userId>
              <firstName></firstName>
              <lastName></lastName>
              <displayName></displayName>
              <inactive></inactive>
              <userName></userName>
              <userType></userType>
      </user>
</response>
            

Response (for 'full' list)

<response status="ok">
   <user>
        <addressHome_City></addressHome_City>
        <addressHome_Country></addressHome_Country>
        <addressHome_PostalCode></addressHome_PostalCode>
        <addressHome_State></addressHome_State>
        <addressHome_Street></addressHome_Street>
        <addressWork_City></addressWork_City>
        <addressWork_Country></addressWork_Country>
        <addressWork_PostalCode></addressWork_PostalCode>
        <addressWork_State></addressWork_State>
        <addressWork_Street></addressWork_Street>
        <allowAPI></allowAPI>
        <cultureName></cultureName>
        <dateLastLogin></dateLastLogin>
        <dateTimeCreated></dateTimeCreated>
        <defaultLaborRateId></defaultLaborRateId>
        <displayName></displayName>
        <email></email>
        <firstName></firstName>
        <fullName></fullName>
        <inactive></inactive>
        <jobTitle></jobTitle>
        <lastName></lastName>
        <link1Name></link1Name>
        <link1Url></link1Url>
        <link2Name></link2Name>
        <link2Url></link2Url>
        <loginCount></loginCount>
        <middleName></middleName>
        <phone></phone>
        <phoneFax></phoneFax>
        <phoneMobile></phoneMobile>
        <roles>
          <role>
            <name></name>
            <customName></customName>
          </role>
        </roles>
        <sendSystemNotifications></sendSystemNotifications>
        <textMsgAddress></textMsgAddress>
        <timeObserveDST></timeObserveDST>
        <timeZoneOffset></timeZoneOffset>
        <userId></userId>
        <userName></userName>
        <userType></userType>
        <workHoursEnd></workHoursEnd>
        <workHoursStart></workHoursStart>
   </user>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request