Users

Users endpoints allow access to User data within CMap

Get Users

HTTP GET v1/users

Returns all unarchived users

_Response

[
  {
	"ddi" : "016125 521 002"
	"email" : "jim.murphy@ozone.com"
	"firstname" : "Jim",
	"id" : "23423",
	"jobTitle" : "Director",
	"lastname" : "Murphy",
	"mobile" : "07955 876 365",
	"officeTelephone" : "01625 521 000" 
  },
  //...
]

Get Users By Query

HTTP GET v1/users?q=[query]

Returns all unarchived users which match the search query

_Response

[
  {
	"ddi" : "016125 521 002"
	"email" : "jim.murphy@ozone.com"
	"firstname" : "Jim",
	"id" : "23423",
	"jobTitle" : "Director",
	"lastname" : "Murphy",
	"mobile" : "07955 876 365",
	"officeTelephone" : "01625 521 000" 
  },
  //...
]

Get Current User Details

HTTP GET v1/users/current

Returns the details for the logged in user

_Response

{
	"userId": 123456,
	"firstname": "Arthur",
	"lastname": "Dent",
	"locale": "en-gb",
	"timesheetWeek": "2019-07-22T00:00:00",
	"timeZone": "GMT Standard Time",
	"currencyId": 2,
	"currency": "United States Dollars",
	"currencyAbbreviated": "USD",
	"workingHours": 37.5,
	"dateFormat": "dd-mm-yy"
  }

[
  {
	"userId": 123456,
	"firstname": "Arthur",
	"lastname": "Dent",
	"locale": "en-gb",
	"timesheetWeek": "2019-07-22T00:00:00",
	"timeZone": "GMT Standard Time",
	"currencyId": 2,
	"currency": "United States Dollars",
	"currencyAbbreviated": "USD",
	"workingHours": 37.5,
	"dateFormat": "dd-mm-yy"
  }
]

Get Current User Status

HTTP GET v1/users/status

Returns status information for the logged in user such as current timesheet week, holiday days remaining, no. of weeks behind on their timesheet etc..

_Response

{
  "additionalTime": true, /* whether or not the client has the additional time feature activated */
  "workingHours": "37.5", /* The user's current working hours */
  "weeksOverdue": "4", /* number of weeks behind on their timesheets */
  "timesheetWeek": "2015-11-16",
  "openClaims": "3", /* no. of open expense claims */
  "overdueActivities": "0",
  "todaysActivities": "5",
  "contacts": "4534", /* no. of contacts in the client's database */
  "users": "45", /* no. of user accounts */
  "daysRemaining": "1.5" /* no. of holiday days remaining */
}

Create User

HTTP POST v1/users

Creates a User in CMAP

To specify data for Dropdown Lists, Multi-Select Dropdown Lists, Multi-Select Dropdown Lists with Score the dropdown options must be setup in CMap first.

To specify data for the User Dropdown List or User Multi-Select Dropdown Lists, the user's UserID is required.

_Request

{
  "Firstname": "David",
  "Lastname": "Smith",
  "Email": "david.smith@abccorp.com",
  "StartDate": "2020-01-01", /* must be in this format*/
  "Status": "Employee",
  "Office": "UK",
  "Team": "Manchester",
  "JobTitle": "Architect",
  "DefaultRole": "Architect",
  "Currency": "GBP",
  "WorkingHours": "37.5",
  "LineManager": "brian.davies@abccorp.com", /* must be an email address */
  "TimeOffApprover": "brian.davies@abccorp.com", /* must be an email address */
  "ExpenseApprover": "brian.davies@abccorp.com", /* must be an email address */
  "CustomFields": {
    "SampleTextField": "Example Text",
    "SampleNumberField": 12345.67,
    "SampleDropdownList": "Item 1",
    "SampleDateField": "2022-05-27",
    "SampleYesNo": true | false,
    "SampleMultiLineTextField": "A longer piece of text",
    "SampleMultiSelectDropdown": [
      "Item 1",
      "Item 2",
      "Item 4"
    ],
    "SampleMultiSelectWithScore": [
      {
        "Option": "Item 1",
        "Score": 25
      },
      {
        "Option": "Item 3",
        "Score": 75
      }
    ],
    "SampleUserDropdownList": 130889,
    "SampleUserMultiSelectDropdownList": [
      130889,
      133900
    ]
  }
}

_Response

{
  "userId" : 1234
}

Update User

HTTP PUT v1/users

Updates a User in CMap.

To specify data for Dropdown Lists, Multi-Select Dropdown Lists, Multi-Select Dropdown Lists with Score the dropdown options must be setup in CMap first.

To specify data for the User Dropdown List or User Multi-Select Dropdown Lists, the user's UserID is required.

_Request

{
  "UserID": "12345",
  "Firstname": "David",
  "Lastname": "Smith",
  "Email": "david.smith@abccorp.com",
  "StartDate": "2020-01-01", /* must be in this format*/
  "Status": "Employee",
  "Office": "UK",
  "Team": "Manchester",
  "JobTitle": "Architect",
  "DefaultRole": "Architect",
  "Currency": "GBP",
  "WorkingHours": "37.5",
  "LineManager": "brian.davies@abccorp.com", /* must be an email address */
  "TimeOffApprover": "brian.davies@abccorp.com", /* must be an email address */
  "ExpenseApprover": "brian.davies@abccorp.com", /* must be an email address */
  "CustomFields": {
    "SampleTextField": "Example Text",
    "SampleNumberField": 12345.67,
    "SampleDropdownList": "Item 1",
    "SampleDateField": "2022-05-27",
    "SampleYesNo": true | false,
    "SampleMultiLineTextField": "A longer piece of text",
    "SampleMultiSelectDropdown": [
      "Item 1",
      "Item 2",
      "Item 4"
    ],
    "SampleMultiSelectWithScore": [
      {
        "Option": "Item 1",
        "Score": 25
      },
      {
        "Option": "Item 3",
        "Score": 75
      }
    ],
    "SampleUserDropdownList": 130889,
    "SampleUserMultiSelectDropdownList": [
      130889,
      133900
    ]
  }
}

_Response

{
  "userId" : 1234
}

An HTTP 402 response indicates a licensing issue which will need to be resolved with your CMap account manager