Skip to main content
Cartegraph Campus

User for REST API

This feature may not be available in every package. Not sure if you have this feature or you want to learn more about it? Send us a message at support@cartegraph.com. 

Cartegraph's API is a licensed product that requires a purchase and verified ownership before production use.

  • Purpose: Allows a client to gather various information about the currently signed in user.
  • HTTP Method: GET
  • URL: https://yourserver.com/cartegraph/api/v1/user
  • No Parameters
  • IdentityLevel:
    • 0 => Cartegraph User
    • 1 => Esri Level 1 User
    • 2 => Esri Level 2 User

Example Request

GET https://yourserver.com/cartegraph/api/v1/user

Responses

Success

A success object is returned with a 200 OK status code.

{
    "UserName": "Jim",
    "EsriUsername": "cgJimSmith",
    "FirstName": "James",
    "LastName": "Smith",
    "Email": "JamesSmith@cartegraph.com",
    "Role": "Default Administrator",
    "IdentityLevel": 0
}

Error

Attempting to access the API prior to being authenticated or after a valid authentication has expired will result in a 401 Unauthorized status code in the response. An ApiError object is returned.

{ "Message": "Authentication Required for API Access." }