Back to top

C-TIP API

Welcome the C-TIP API. This API provides access to your own GeoSpatial data and environment.

API Description

In this section we will go over the general calls and how to use the C-TIP API.

Login

When an account is created for you, you have access to a password and an email address. With this information you can obtain an API key.

Authentication is done based on JWT tokens that have an expiration time of 24 hours.

See the Authorization section for more information how to login to the API.

Authentication

Requesting any endpoint except the authentication will require you to send your token. This token will be given to you in the login response after a successful login, called ‘access_token’. Sending this token with any call can be done in two-ways. Either by Header or in the Query of an request.

Header

Use the following header to prove authorization of your request.

Authorization: Bearer vr5HmMkzlxKE70W1y4MibiJUusZwZC25NOVBEx3BD1

Notice Bearer has a capital B

Session

After login, the API remembers your session and to which tenant and to which tenant you are connected to. All calls are done on that specific tenant and network If you want to switch to another tenant and/or network, you have to change your session by setting the x-tenant and/or x-network header with the tenant id and/or the network id.

x-tenant: 1;
x-network: 1;

Authorization

Calls for authorizing with the api

Authorize

Login using credentials
POST/oauth/access_token

Login with user credentials and a tenant id.

Example URI

POST https://api.c-tip.com/v1/oauth/access_token
Request
HideShow
Body
{
  "client_id": 1,
  "client_secret": "c3ViIjoxLCJpc3MiOiJodHRwOlwvXC9kYy5kZXZcL3YxXC9",
  "grant_type": "password",
  "username": "user@rapide.software",
  "password": "password"
}
Schema
{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "number",
      "description": "Client ID to connect to the API"
    },
    "client_secret": {
      "type": "string",
      "description": "Client Secret to connect to the API"
    },
    "grant_type": {
      "type": "string",
      "description": "Grant type to gain access to the API (Standard: password)"
    },
    "username": {
      "type": "string",
      "description": "Email address of user"
    },
    "password": {
      "type": "string",
      "description": "Password of user"
    }
  },
  "required": [
    "client_id",
    "client_secret",
    "grant_type",
    "username",
    "password"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0bnQiOiIxIiwic3ViIjoxLCJpc3MiOiJodHRwOlwvXC9kYy5kZXZcL3YxXC9hdXRoIiwiaWF0IjoxNDUwMjU3OTg3LCJleHAiOjE0NTAzNDQzODcsIm5iZiI6MTQ1MDI1Nzk4NywianRpIjoiZDY2NDRkNTRkZjQ1NTQ3Y2RhNDA3N2E4Yzk1ZTg5MzgifQ.XCUiCnttOxnVRV8wsbsCTVgWCDhVwVqo0CK",
      "tenant_id": 2,
      "username": "user@rapide.software",
      "user_id": 1,
      "permissions": {
        "data": [
          "index_object"
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Actions

All calls for action management

Action list

Get a list of actions

Get actions
GET/action{?perPage}

Get a list of actions.

Example URI

GET https://api.c-tip.com/v1/action?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of actions to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "map_object_type_id": 2,
      "action_status_id": 3,
      "map_object_id": 7,
      "geo_object_id": 2,
      "dynamic_action_type_id": 9,
      "action_priority_id": 10,
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new action
POST/action{?perPage}

Create a new action with the required parameters.

New actions

New actions are coupled to your current tenant.

Example URI

POST https://api.c-tip.com/v1/action?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of actions to return

Request
HideShow
Body
{
  "data": {
    "map_object_type_id": 2,
    "action_status_id": 3,
    "map_object_id": 7,
    "geo_object_id": 2,
    "dynamic_action_type_id": 9,
    "action_priority_id": 10
  },
  "auth": {
    "accessor_type": "user",
    "access_level": 7,
    "accessor_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "map_object_type_id": {
          "type": "number",
          "description": "Id of primary tenant"
        },
        "action_status_id": {
          "type": "number",
          "description": "Id of the current action status"
        },
        "map_object_id": {
          "type": "number",
          "description": "Id of the coupled map_object"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of the location object"
        },
        "dynamic_action_type_id": {
          "type": "number",
          "description": "Id of the dynamic action type"
        },
        "action_priority_id": {
          "type": "number",
          "description": "Id of the current priority"
        }
      },
      "required": [
        "map_object_type_id",
        "action_status_id",
        "dynamic_action_type_id",
        "action_priority_id"
      ]
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessor_type": {
          "enum": [
            "user",
            "role",
            "tenant"
          ],
          "description": "Type of authorization"
        },
        "access_level": {
          "type": "number",
          "description": "Accesslevel bit (read,write,full)"
        },
        "accessor_id": {
          "type": "number",
          "description": "Identifier of accessor type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

Action

Get a specific actions

Get Action
GET/action/{id}

Get a action.

Example URI

GET https://api.c-tip.com/v1/action/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific action

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "map_object_type_id": 2,
    "action_status_id": 3,
    "map_object_id": 7,
    "geo_object_id": 2,
    "dynamic_action_type_id": 9,
    "action_priority_id": 10,
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Action identifier"
        },
        "map_object_type_id": {
          "type": "number",
          "description": "Id of primary tenant"
        },
        "action_status_id": {
          "type": "number",
          "description": "Id of the current action status"
        },
        "map_object_id": {
          "type": "number",
          "description": "Id of the coupled map_object"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of the location object"
        },
        "dynamic_action_type_id": {
          "type": "number",
          "description": "Id of the dynamic action type"
        },
        "action_priority_id": {
          "type": "number",
          "description": "Id of the current priority"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of action creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last action update"
        }
      }
    }
  }
}

Update an existing action
PUT/action/{id}

Update a action

Example URI

PUT https://api.c-tip.com/v1/action/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific action

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "action_status_id": 3,
    "geo_object_id": 2,
    "action_priority_id": 10
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Action identifier"
        },
        "action_status_id": {
          "type": "number",
          "description": "Id of the current action status"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of the location object"
        },
        "action_priority_id": {
          "type": "number",
          "description": "Id of the current priority"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json

Patch an existing action
PATCH/action/{id}

Patch a action

Example URI

PATCH https://api.c-tip.com/v1/action/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific action

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "action_status_id": 3,
    "geo_object_id": 2,
    "action_priority_id": 10
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Action identifier"
        },
        "action_status_id": {
          "type": "number",
          "description": "Id of the current action status"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of the location object"
        },
        "action_priority_id": {
          "type": "number",
          "description": "Id of the current priority"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json

Delete an existing action
DELETE/action/{id}

Delete a action

Example URI

DELETE https://api.c-tip.com/v1/action/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific action

Response  200
HideShow
Headers
Content-Type: application/json

MapObjects

All calls for MapObject management

MapObject list

Get a list of MapObjects

Get MapObjects
GET/object{?perPage}{?include}

Get a list of MapObjects.

Example URI

GET https://api.c-tip.com/v1/object?perPage=25?include=action
URI Parameters
HideShow
perPage
number (optional) Default: 15 Example: 25

The maximum number of objects to return

include
string (optional) Example: action

Option to get related data, multiple options are available by joining them with a ‘,’ in between (i.e. ‘attribute,action’). WARNING: this may increase loading times drastically

Choices: action mapObjectType mapObjectStatus mapObjectImage mapObjectSelection attribute actionCount children parents mapObjectSelectionId mapObjectLabel createdBy startPoint endPoint

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Bord",
      "parent_id": 2,
      "map_object_type_id": 3,
      "geo_object_id": 4,
      "map_object_status_id": 5,
      "geoObject": {
        "data": {
          "type": "Feature",
          "geometry": {
            "type": "Polygon",
            "coordinates": []
          },
          "properties": {
            "road": "AbcStreet",
            "house_number": "12",
            "city_district": "AbcDistrict",
            "city": "AbcCity",
            "postcode": "1234 AB",
            "country_code": 528,
            "length": 1000,
            "start_point": 123,
            "end_point": 123,
            "area": 1000
          },
          "id": 1
        }
      },
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new MapObject
POST/object{?perPage}{?include}

Create a new MapObject with the required parameters.

Example URI

POST https://api.c-tip.com/v1/object?perPage=25?include=action
URI Parameters
HideShow
perPage
number (optional) Default: 15 Example: 25

The maximum number of objects to return

include
string (optional) Example: action

Option to get related data, multiple options are available by joining them with a ‘,’ in between (i.e. ‘attribute,action’). WARNING: this may increase loading times drastically

Choices: action mapObjectType mapObjectStatus mapObjectImage mapObjectSelection attribute actionCount children parents mapObjectSelectionId mapObjectLabel createdBy startPoint endPoint

Request
HideShow
Body
{
  "data": {
    "name": "Bord",
    "parent_id": 2,
    "map_object_type_id": 3,
    "geo_object_id": 4,
    "map_object_status_id": 5
  },
  "auth": {
    "accessor_type": "user",
    "access_level": 7,
    "accessor_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the object"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent object"
        },
        "map_object_type_id": {
          "type": "number",
          "description": "Id of the object type"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of of the location object"
        },
        "map_object_status_id": {
          "type": "number",
          "description": "Id of the current status"
        }
      }
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessor_type": {
          "enum": [
            "user",
            "role",
            "tenant"
          ],
          "description": "Type of authorization"
        },
        "access_level": {
          "type": "number",
          "description": "Accesslevel bit (read,write,full)"
        },
        "accessor_id": {
          "type": "number",
          "description": "Identifier of accessor type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

MapObject

Get a specific objects

Get MapObject
GET/object/{id}

Get a MapObject.

Example URI

GET https://api.c-tip.com/v1/object/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Bord",
    "parent_id": 2,
    "map_object_type_id": 3,
    "geo_object_id": 4,
    "map_object_status_id": 5,
    "geoObject": {
      "data": {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": []
        },
        "properties": {
          "road": "AbcStreet",
          "house_number": "12",
          "city_district": "AbcDistrict",
          "city": "AbcCity",
          "postcode": "1234 AB",
          "country_code": 528,
          "length": 1000,
          "start_point": 123,
          "end_point": 123,
          "area": 1000
        },
        "id": 1
      }
    },
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObject identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the object"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent object"
        },
        "map_object_type_id": {
          "type": "number",
          "description": "Id of the object type"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of of the location object"
        },
        "map_object_status_id": {
          "type": "number",
          "description": "Id of the current status"
        },
        "geoObject": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Type of format"
                },
                "geometry": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Type of geometry object"
                    },
                    "coordinates": {
                      "description": "Array of coordinates"
                    }
                  }
                },
                "properties": {
                  "type": "object",
                  "properties": {
                    "road": {
                      "type": "string",
                      "description": "Road of the GeoObject"
                    },
                    "house_number": {
                      "type": "string",
                      "description": "House number of the GeoObject"
                    },
                    "city_district": {
                      "type": "string",
                      "description": "City district of the GeoObject"
                    },
                    "city": {
                      "type": "string",
                      "description": "City of the GeoObject"
                    },
                    "postcode": {
                      "type": "string",
                      "description": "Postcode of the GeoObject"
                    },
                    "country_code": {
                      "type": "number",
                      "description": "Country Code of the GeoObject"
                    },
                    "length": {
                      "type": "number",
                      "description": "Length of the GeoObject (Only for LineStrings)"
                    },
                    "start_point": {
                      "type": "number",
                      "description": "MapObjectId of startpoint of the GeoObject (Only for LineStrings)"
                    },
                    "end_point": {
                      "type": "number",
                      "description": "MapObjectId of endpoint of the GeoObject (Only for LineStrings)"
                    },
                    "area": {
                      "type": "number",
                      "description": "Area of the GeoObject (Only for Polygons)"
                    }
                  },
                  "description": "Object with properties of object"
                },
                "id": {
                  "type": "number",
                  "description": "Id of geoObject"
                }
              }
            }
          }
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of object creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last object update"
        }
      }
    }
  }
}

Update an existing MapObject
PUT/object/{id}

Update a MapObject

Example URI

PUT https://api.c-tip.com/v1/object/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "Bord",
    "parent_id": 3,
    "map_object_status_id": 5
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObject identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the object"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent object"
        },
        "map_object_status_id": {
          "type": "number",
          "description": "Id of the current status"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing MapObject
PATCH/object/{id}

Patch a MapObject

Example URI

PATCH https://api.c-tip.com/v1/object/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "Bord",
    "parent_id": 3,
    "map_object_status_id": 5
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObject identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the object"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent object"
        },
        "map_object_status_id": {
          "type": "number",
          "description": "Id of the current status"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing MapObject
DELETE/object/{id}

Delete a MapObject

Example URI

DELETE https://api.c-tip.com/v1/object/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

MapObjectImages

All calls for mapObject image management

MapObjectImage list

Get a list of mapObject images

Get mapObject images
GET/object/{mapObjectId}/image{?perPage}

Get a list of mapObject images.

Example URI

GET https://api.c-tip.com/v1/object/1/image?perPage=25
URI Parameters
HideShow
mapObjectId
integer (required) Example: 1

Id of an mapObject

perPage
integer (optional) Default: 15 Example: 25

The maximum number of mapObject images to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "map_object_id": 2,
      "resource": "F34xfds",
      "title": "Nice picture"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new mapObject image
POST/object/{mapObjectId}/image{?perPage}

Create a new mapObject image with the required parameters.

Example URI

POST https://api.c-tip.com/v1/object/1/image?perPage=25
URI Parameters
HideShow
mapObjectId
integer (required) Example: 1

Id of an mapObject

perPage
integer (optional) Default: 15 Example: 25

The maximum number of mapObject images to return

Request
HideShow
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Content-Length: $requestlen
Body
---BOUNDARY
content-disposition: form-data; name="name"

Title

---BOUNDARY
content-disposition: form-data; name="image"; filename="$filename"
Content-Type: $mimetype
Content-Transfer-Encoding: binary

$binarydata
---BOUNDARY
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

MapObjectImage

Get a specific mapObject images

Get MapObjectImage
GET/object/{mapObjectId}image/{id}

Get a mapObject image.

Example URI

GET https://api.c-tip.com/v1/object/1image/1
URI Parameters
HideShow
mapObjectId
integer (required) Example: 1

Id of an mapObject

id
integer (required) Example: 1

Id of a specific mapObject image

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "map_object_id": 2,
    "resource": "F34xfds",
    "title": "Nice picture"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObjectImage identifier"
        },
        "map_object_id": {
          "type": "number",
          "description": "Id of coupled mapObject"
        },
        "resource": {
          "type": "string",
          "description": "Resource key?"
        },
        "title": {
          "type": "string",
          "description": "Title of the image"
        }
      }
    }
  }
}

Update an existing mapObject image
PUT/object/{mapObjectId}image/{id}

Update a mapObject image

Example URI

PUT https://api.c-tip.com/v1/object/1image/1
URI Parameters
HideShow
mapObjectId
integer (required) Example: 1

Id of an mapObject

id
integer (required) Example: 1

Id of a specific mapObject image

Request
HideShow
Body
{
  "title": "Nice picture"
}
Schema
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the image"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing mapObject image
PATCH/object/{mapObjectId}image/{id}

Patch a mapObject image

Example URI

PATCH https://api.c-tip.com/v1/object/1image/1
URI Parameters
HideShow
mapObjectId
integer (required) Example: 1

Id of an mapObject

id
integer (required) Example: 1

Id of a specific mapObject image

Request
HideShow
Body
{
  "title": "Nice picture"
}
Schema
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the image"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing mapObject image
DELETE/object/{mapObjectId}image/{id}

Delete a mapObject image

Example URI

DELETE https://api.c-tip.com/v1/object/1image/1
URI Parameters
HideShow
mapObjectId
integer (required) Example: 1

Id of an mapObject

id
integer (required) Example: 1

Id of a specific mapObject image

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

MapObjectTypes

All calls for mapObjectType management

MapObjectType list

Get a list of mapObjectTypes

Get mapObjectTypes
GET/type{?perPage}

Get a list of mapObjectTypes.

Example URI

GET https://api.c-tip.com/v1/type?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Network",
      "description": "Root node network",
      "map_object_category_id": 1,
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new mapObjectType
POST/type{?perPage}

Create a new mapObjectType with the required parameters.

Example URI

POST https://api.c-tip.com/v1/type?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Request
HideShow
Body
{
  "data": {
    "name": "Network",
    "description": "Root node network",
    "map_object_category_id": 1
  },
  "auth": {
    "accessor_type": "user",
    "access_level": 7,
    "accessor_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the mapObjectType"
        },
        "description": {
          "type": "string",
          "description": "Description of the mapObjectType"
        },
        "map_object_category_id": {
          "type": "number",
          "description": "Id of the mapObjectCategory the mapObjectType belongs to"
        }
      }
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessor_type": {
          "enum": [
            "user",
            "role",
            "tenant"
          ],
          "description": "Type of authorization"
        },
        "access_level": {
          "type": "number",
          "description": "Accesslevel bit (read,write,full)"
        },
        "accessor_id": {
          "type": "number",
          "description": "Identifier of accessor type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

MapObjectType

Get a specific mapObjectType

Get MapObjectType
GET/type/{id}

Get a mapObjectType.

Example URI

GET https://api.c-tip.com/v1/type/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific mapObjectType

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Network",
    "description": "Root node network",
    "map_object_category_id": 1,
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObjectType identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the mapObjectType"
        },
        "description": {
          "type": "string",
          "description": "Description of the mapObjectType"
        },
        "map_object_category_id": {
          "type": "number",
          "description": "Id of the mapObjectCategory the mapObjectType belongs to"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of user creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last user update"
        }
      }
    }
  }
}

Update an existing mapObjectType
PUT/type/{id}

Update a mapObjectType

Example URI

PUT https://api.c-tip.com/v1/type/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific mapObjectType

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "Network",
    "description": "Root node network",
    "map_object_category_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObjectType identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the mapObjectType"
        },
        "description": {
          "type": "string",
          "description": "Description of the mapObjectType"
        },
        "map_object_category_id": {
          "type": "number",
          "description": "Id of the mapObjectCategory the mapObjectType belongs to"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing mapObjectType
PATCH/type/{id}

Patch a mapObjectType

Example URI

PATCH https://api.c-tip.com/v1/type/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific mapObjectType

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "Network",
    "description": "Root node network",
    "map_object_category_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "MapObjectType identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the mapObjectType"
        },
        "description": {
          "type": "string",
          "description": "Description of the mapObjectType"
        },
        "map_object_category_id": {
          "type": "number",
          "description": "Id of the mapObjectCategory the mapObjectType belongs to"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing mapObjectType
DELETE/type/{id}

Delete a mapObjectType

Example URI

DELETE https://api.c-tip.com/v1/type/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific mapObjectType

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

Network

All calls for Network management

Network list

Get a list of Networks

Get Networks
GET/network{?perPage}

Get a list of Networks.

Example URI

GET https://api.c-tip.com/v1/network?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of objects to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "FKP Groningen",
      "geo_object_id": 4,
      "geoObject": {
        "data": {
          "type": "Feature",
          "geometry": {
            "type": "Polygon",
            "coordinates": []
          },
          "properties": {
            "road": "AbcStreet",
            "house_number": "12",
            "city_district": "AbcDistrict",
            "city": "AbcCity",
            "postcode": "1234 AB",
            "country_code": 528,
            "length": 1000,
            "start_point": 123,
            "end_point": 123,
            "area": 1000
          },
          "id": 1
        }
      },
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new Network
POST/network{?perPage}

Create a new Network with the required parameters.

Example URI

POST https://api.c-tip.com/v1/network?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of objects to return

Request
HideShow
Body
{
  "data": {
    "name": "Bord",
    "geo_object_id": 4
  },
  "auth": {
    "accessor_type": "user",
    "access_level": 7,
    "accessor_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the object"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of of the location object"
        }
      }
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessor_type": {
          "enum": [
            "user",
            "role",
            "tenant"
          ],
          "description": "Type of authorization"
        },
        "access_level": {
          "type": "number",
          "description": "Accesslevel bit (read,write,full)"
        },
        "accessor_id": {
          "type": "number",
          "description": "Identifier of accessor type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

Network

Get a specific objects

Get Network
GET/network/{id}

Get a Network.

Example URI

GET https://api.c-tip.com/v1/network/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "FKP Groningen",
    "geo_object_id": 4,
    "geoObject": {
      "data": {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": []
        },
        "properties": {
          "road": "AbcStreet",
          "house_number": "12",
          "city_district": "AbcDistrict",
          "city": "AbcCity",
          "postcode": "1234 AB",
          "country_code": 528,
          "length": 1000,
          "start_point": 123,
          "end_point": 123,
          "area": 1000
        },
        "id": 1
      }
    },
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Network identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the object"
        },
        "geo_object_id": {
          "type": "number",
          "description": "Id of of the location object"
        },
        "geoObject": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Type of format"
                },
                "geometry": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Type of geometry object"
                    },
                    "coordinates": {
                      "description": "Array of coordinates"
                    }
                  }
                },
                "properties": {
                  "type": "object",
                  "properties": {
                    "road": {
                      "type": "string",
                      "description": "Road of the GeoObject"
                    },
                    "house_number": {
                      "type": "string",
                      "description": "House number of the GeoObject"
                    },
                    "city_district": {
                      "type": "string",
                      "description": "City district of the GeoObject"
                    },
                    "city": {
                      "type": "string",
                      "description": "City of the GeoObject"
                    },
                    "postcode": {
                      "type": "string",
                      "description": "Postcode of the GeoObject"
                    },
                    "country_code": {
                      "type": "number",
                      "description": "Country Code of the GeoObject"
                    },
                    "length": {
                      "type": "number",
                      "description": "Length of the GeoObject (Only for LineStrings)"
                    },
                    "start_point": {
                      "type": "number",
                      "description": "MapObjectId of startpoint of the GeoObject (Only for LineStrings)"
                    },
                    "end_point": {
                      "type": "number",
                      "description": "MapObjectId of endpoint of the GeoObject (Only for LineStrings)"
                    },
                    "area": {
                      "type": "number",
                      "description": "Area of the GeoObject (Only for Polygons)"
                    }
                  },
                  "description": "Object with properties of object"
                },
                "id": {
                  "type": "number",
                  "description": "Id of geoObject"
                }
              }
            }
          }
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of object creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last object update"
        }
      }
    }
  }
}

Update an existing Network
PUT/network/{id}

Update a Network

Example URI

PUT https://api.c-tip.com/v1/network/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "WNT Groningen"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Network identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the object"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing Network
PATCH/network/{id}

Patch a Network

Example URI

PATCH https://api.c-tip.com/v1/network/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "WNT Groningen"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Network identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the object"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing Network
DELETE/network/{id}

Delete a Network

Example URI

DELETE https://api.c-tip.com/v1/network/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

NetworkChildren

All calls to get a lot of objects under a single network

Network Children

Get Network Children
GET/network/{id}/children{?perPage}{?depth}

Get the children objects under a network.

Example URI

GET https://api.c-tip.com/v1/network/1/children?perPage=25?depth=true
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific network

perPage
integer (optional) Default: 15 Example: 25

The maximum number of objects to return

depth
boolean (optional) Default: false Example: true

Whether you only want the MapObject directly under the network, or also the children of those mapObjects and deeper

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Bord",
      "parent_id": 2,
      "map_object_type_id": 3,
      "geo_object_id": 4,
      "map_object_status_id": 5,
      "geoObject": {
        "data": {
          "type": "Feature",
          "geometry": {
            "type": "Polygon",
            "coordinates": []
          },
          "properties": {
            "road": "AbcStreet",
            "house_number": "12",
            "city_district": "AbcDistrict",
            "city": "AbcCity",
            "postcode": "1234 AB",
            "country_code": 528,
            "length": 1000,
            "start_point": 123,
            "end_point": 123,
            "area": 1000
          },
          "id": 1
        }
      },
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Network Children Web

Get Network Web
GET/network/{id}/children/web

Get all the children MapObjects under a network in an array format.

Example URI

GET https://api.c-tip.com/v1/network/1/children/web
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific network

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "Bord",
    "parent_id": 2,
    "map_object_type_id": 3,
    "geo_object_id": 4,
    "map_object_status_id": 5,
    "created_at": 1449143207,
    "updated_at": 1449143207,
    "deleted_at": 0,
    "geo_type": "Point",
    "country_code": 528,
    "road": "AbcStreet",
    "house_number": "123",
    "neighbourhood": "AbcNeighbourhood",
    "suburb": "AbcSuburb",
    "city_district": "AbcDistrict",
    "city": "AbcCity",
    "postcode": "1234 AB",
    "length": 100,
    "start_point": 123,
    "end_point": 123,
    "area": 1000,
    "value_linestring": "SRID=4326;LineString(53.472422099307 6.157922744751, 53.472422099307 6.157922744751)",
    "value_point": "SRID=4326;POINT(53.472422099307 6.157922744751)",
    "value_polygon": "SRID=4326;Polygon(53.472422099307 6.157922744751, 53.472422099307 6.157922744751)",
    "label": "5"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Network Children All

Get Network All
GET/network/{id}/children/all

Get all the objects under a network.

Example URI

GET https://api.c-tip.com/v1/network/1/children/all
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific network

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "actionImageTypes": {},
  "actionPriorities": {},
  "actionStatuses": {},
  "attributes": {},
  "attributeGroups": {},
  "dynamicActionTypes": {},
  "dynamicActionTypeCategories": {},
  "keyValues": {},
  "mapObjectCategories": {},
  "mapObjectSelections": {},
  "mapObjectSelectionTypes": {},
  "mapObjectStatuses": {},
  "mapObjectTypes": {},
  "mapObjectTypeMapObjectStatuses": {},
  "mapObjectTypeActionStatuses": {},
  "actions": {},
  "mapObjects": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "actionImageTypes": {
      "type": "object",
      "properties": {}
    },
    "actionPriorities": {
      "type": "object",
      "properties": {}
    },
    "actionStatuses": {
      "type": "object",
      "properties": {}
    },
    "attributes": {
      "type": "object",
      "properties": {}
    },
    "attributeGroups": {
      "type": "object",
      "properties": {}
    },
    "dynamicActionTypes": {
      "type": "object",
      "properties": {}
    },
    "dynamicActionTypeCategories": {
      "type": "object",
      "properties": {}
    },
    "keyValues": {
      "type": "object",
      "properties": {}
    },
    "mapObjectCategories": {
      "type": "object",
      "properties": {}
    },
    "mapObjectSelections": {
      "type": "object",
      "properties": {}
    },
    "mapObjectSelectionTypes": {
      "type": "object",
      "properties": {}
    },
    "mapObjectStatuses": {
      "type": "object",
      "properties": {}
    },
    "mapObjectTypes": {
      "type": "object",
      "properties": {}
    },
    "mapObjectTypeMapObjectStatuses": {
      "type": "object",
      "properties": {}
    },
    "mapObjectTypeActionStatuses": {
      "type": "object",
      "properties": {}
    },
    "actions": {
      "type": "object",
      "properties": {}
    },
    "mapObjects": {
      "type": "object",
      "properties": {}
    }
  }
}

Network Children Config

Get Network Config
GET/network/{id}/children/config

Get all the objects under a network.

Example URI

GET https://api.c-tip.com/v1/network/1/children/config
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific network

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "actionImageTypes": {},
  "actionPriorities": {},
  "actionStatuses": {},
  "attributes": {},
  "attributeGroups": {},
  "dynamicActionTypes": {},
  "dynamicActionTypeCategories": {},
  "keyValues": {},
  "mapObjectCategories": {},
  "mapObjectSelections": {},
  "mapObjectSelectionTypes": {},
  "mapObjectStatuses": {},
  "mapObjectTypes": {},
  "mapObjectTypeMapObjectStatuses": {},
  "mapObjectTypeActionStatuses": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "actionImageTypes": {
      "type": "object",
      "properties": {}
    },
    "actionPriorities": {
      "type": "object",
      "properties": {}
    },
    "actionStatuses": {
      "type": "object",
      "properties": {}
    },
    "attributes": {
      "type": "object",
      "properties": {}
    },
    "attributeGroups": {
      "type": "object",
      "properties": {}
    },
    "dynamicActionTypes": {
      "type": "object",
      "properties": {}
    },
    "dynamicActionTypeCategories": {
      "type": "object",
      "properties": {}
    },
    "keyValues": {
      "type": "object",
      "properties": {}
    },
    "mapObjectCategories": {
      "type": "object",
      "properties": {}
    },
    "mapObjectSelections": {
      "type": "object",
      "properties": {}
    },
    "mapObjectSelectionTypes": {
      "type": "object",
      "properties": {}
    },
    "mapObjectStatuses": {
      "type": "object",
      "properties": {}
    },
    "mapObjectTypes": {
      "type": "object",
      "properties": {}
    },
    "mapObjectTypeMapObjectStatuses": {
      "type": "object",
      "properties": {}
    },
    "mapObjectTypeActionStatuses": {
      "type": "object",
      "properties": {}
    }
  }
}

Network Children By MapObjectType

Get Network By MapObjectType
GET/network/{id}/children/type/{typeId}

Get all the objects under a network.

Example URI

GET https://api.c-tip.com/v1/network/1/children/type/3
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific network

typeId
integer (required) Example: 3

Id of a specific MapObjecType

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "Bord",
    "parent_id": 2,
    "map_object_type_id": 3,
    "geo_object_id": 4,
    "map_object_status_id": 5,
    "created_at": 1449143207,
    "updated_at": 1449143207,
    "deleted_at": 0,
    "geo_type": "Point",
    "country_code": 528,
    "road": "AbcStreet",
    "house_number": "123",
    "neighbourhood": "AbcNeighbourhood",
    "suburb": "AbcSuburb",
    "city_district": "AbcDistrict",
    "city": "AbcCity",
    "postcode": "1234 AB",
    "length": 100,
    "start_point": 123,
    "end_point": 123,
    "area": 1000,
    "value_linestring": "SRID=4326;LineString(53.472422099307 6.157922744751, 53.472422099307 6.157922744751)",
    "value_point": "SRID=4326;POINT(53.472422099307 6.157922744751)",
    "value_polygon": "SRID=4326;Polygon(53.472422099307 6.157922744751, 53.472422099307 6.157922744751)",
    "label": "5"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Role

All calls for role management

Role list

Get a list of roles

Get roles
GET/role{?perPage}

Get a list of roles.

Example URI

GET https://api.c-tip.com/v1/role?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of roles to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "admin",
      "display_name": "Admin",
      "description": "Description of admin",
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new role
POST/role{?perPage}

Create a new role with the required parameters.

New roles

New roles are coupled to your current tenant.

Example URI

POST https://api.c-tip.com/v1/role?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of roles to return

Request
HideShow
Body
{
  "data": {
    "name": "admin",
    "display_name": "Admin",
    "description": "Description of admin"
  },
  "auth": {
    "accessor_type": "user",
    "access_level": 7,
    "accessor_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the role, lowercase for identification"
        },
        "display_name": {
          "type": "string",
          "description": "Display label of a role"
        },
        "description": {
          "type": "string",
          "description": "Description of a role"
        }
      }
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessor_type": {
          "enum": [
            "user",
            "role",
            "tenant"
          ],
          "description": "Type of authorization"
        },
        "access_level": {
          "type": "number",
          "description": "Accesslevel bit (read,write,full)"
        },
        "accessor_id": {
          "type": "number",
          "description": "Identifier of accessor type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

Role

Get a specific roles

Get Role
GET/role/{id}

Get a role.

Example URI

GET https://api.c-tip.com/v1/role/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific role

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "admin",
    "display_name": "Admin",
    "description": "Description of admin",
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Role identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the role, lowercase for identification"
        },
        "display_name": {
          "type": "string",
          "description": "Display label of a role"
        },
        "description": {
          "type": "string",
          "description": "Description of a role"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of role creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last role update"
        }
      }
    }
  }
}

Update an existing role
PUT/role/{id}

Update a role

Example URI

PUT https://api.c-tip.com/v1/role/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific role

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "admin",
    "display_name": "Admin",
    "description": "Description of admin"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Role identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the role, lowercase for identification"
        },
        "display_name": {
          "type": "string",
          "description": "Display label of a role"
        },
        "description": {
          "type": "string",
          "description": "Description of a role"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing role
PATCH/role/{id}

Patch a role

Example URI

PATCH https://api.c-tip.com/v1/role/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific role

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "admin",
    "display_name": "Admin",
    "description": "Description of admin"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Role identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the role, lowercase for identification"
        },
        "display_name": {
          "type": "string",
          "description": "Display label of a role"
        },
        "description": {
          "type": "string",
          "description": "Description of a role"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing role
DELETE/role/{id}

Delete a role

Example URI

DELETE https://api.c-tip.com/v1/role/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific role

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

Selections

All calls for Selection management

Selection list

Get a list of Selections

Get Selections
GET/selection{?perPage}{?include}

Get a list of Selections.

Example URI

GET https://api.c-tip.com/v1/selection?perPage=25?include=mapObject
URI Parameters
HideShow
perPage
number (optional) Default: 15 Example: 25

The maximum number of objects to return

include
string (optional) Example: mapObject

Option to get related data, multiple options are available by joining them with a ‘,’ in between (i.e. ‘attribute,parent’). WARNING: this may increase loading times drastically

Choices: mapObject mapObjectSelectionType mapObjectSelectionImage attribute parent mapObjectId

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "parent_id": 2,
      "name": "Selectie",
      "description": "Dit is een omschrijving",
      "map_object_selection_type_id": 3,
      "network_id": 73,
      "status": "ok",
      "created_at": 1449143207,
      "updated_at": 1449143207,
      "created_by": 1
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new Selection
POST/selection{?perPage}{?include}

Create a new Selection with the required parameters.

Example URI

POST https://api.c-tip.com/v1/selection?perPage=25?include=mapObject
URI Parameters
HideShow
perPage
number (optional) Default: 15 Example: 25

The maximum number of objects to return

include
string (optional) Example: mapObject

Option to get related data, multiple options are available by joining them with a ‘,’ in between (i.e. ‘attribute,parent’). WARNING: this may increase loading times drastically

Choices: mapObject mapObjectSelectionType mapObjectSelectionImage attribute parent mapObjectId

Request
HideShow
Body
{
  "data": {
    "name": "Bord",
    "description": "Dit is een omschrijving",
    "parent_id": 3,
    "map_object_selection_type_id": 5
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the selection"
        },
        "description": {
          "type": "string",
          "description": "Description of the selection"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent selection"
        },
        "map_object_selection_type_id": {
          "type": "number",
          "description": "Id of the selection type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

Selection

Get a specific Selection

Get Selection
GET/selection/{id}

Get a Selection.

Example URI

GET https://api.c-tip.com/v1/selection/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "parent_id": 2,
    "name": "Selectie",
    "description": "Dit is een omschrijving",
    "map_object_selection_type_id": 3,
    "network_id": 73,
    "status": "ok",
    "created_at": 1449143207,
    "updated_at": 1449143207,
    "created_by": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Selection identifier"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent selection"
        },
        "name": {
          "type": "string",
          "description": "Name of the selection"
        },
        "description": {
          "type": "string",
          "description": "Description of the selection"
        },
        "map_object_selection_type_id": {
          "type": "number",
          "description": "Id of the selection type"
        },
        "network_id": {
          "type": "number",
          "description": "Id of the network id"
        },
        "status": {
          "type": "string",
          "description": "Status of the selection, options: ok | broken | unknown"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of selection creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last selection update"
        },
        "created_by": {
          "type": "number",
          "description": "User id of the creator of the selection"
        }
      }
    }
  }
}

Update an existing Selection
PUT/selection/{id}

Update a Selection

Example URI

PUT https://api.c-tip.com/v1/selection/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "Bord",
    "description": "Dit is een omschrijving",
    "parent_id": 3,
    "map_object_selection_type_id": 5
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Selection identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the selection"
        },
        "description": {
          "type": "string",
          "description": "Description of the selection"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent selection"
        },
        "map_object_selection_type_id": {
          "type": "number",
          "description": "Id of the selection type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing Selection
PATCH/selection/{id}

Patch a Selection

Example URI

PATCH https://api.c-tip.com/v1/selection/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "name": "Bord",
    "description": "Dit is een omschrijving",
    "parent_id": 3,
    "map_object_selection_type_id": 5
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Selection identifier"
        },
        "name": {
          "type": "string",
          "description": "Name of the selection"
        },
        "description": {
          "type": "string",
          "description": "Description of the selection"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent selection"
        },
        "map_object_selection_type_id": {
          "type": "number",
          "description": "Id of the selection type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing Selection
DELETE/selection/{id}

Delete a Selection

Example URI

DELETE https://api.c-tip.com/v1/selection/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific object

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

Tenants

All calls for tenant management

Tenant list

Get a list of tenants

Get Tenants
GET/tenant{?perPage}

Get a list of tenants.

Example URI

GET https://api.c-tip.com/v1/tenant?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "parent_id": 2,
      "name": "Office B.V.",
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new tenant
POST/tenant{?perPage}

Create a new tenant with the required parameters.

Example URI

POST https://api.c-tip.com/v1/tenant?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Request
HideShow
Body
{
  "data": {
    "name": "Company B.V.",
    "parent_id": 3
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the tenant"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of parent tenant, empty means create a root tenant"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

Tenants

Get a specific tenants

Get Tenant
GET/tenant/{id}

Get a tenant.

Example URI

GET https://api.c-tip.com/v1/tenant/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific tenant

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "parent_id": 2,
    "name": "Office B.V.",
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Tenant identifier"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of the parent tenant, null means this is a root tenant"
        },
        "name": {
          "type": "string",
          "description": "Name of the tenant"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of tenant creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last tenant update"
        }
      }
    }
  }
}

Update an existing tenant
PUT/tenant/{id}

Update a tenant

Example URI

PUT https://api.c-tip.com/v1/tenant/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific tenant

Request
HideShow
Body
{
  "data": {
    "name": "Company B.V."
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the tenant"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing tenant
PATCH/tenant/{id}

Patch a tenant

Example URI

PATCH https://api.c-tip.com/v1/tenant/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific tenant

Request
HideShow
Body
{
  "data": {
    "name": "Company B.V."
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the tenant"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing tenant
DELETE/tenant/{id}

Delete a tenant

Example URI

DELETE https://api.c-tip.com/v1/tenant/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific tenant

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

Tenant User Relation

All calls for tenant user relation management

TenantUser Relation

Create new tenant user relation
POST/tenant/{tenantId}/user{?sync}

Create a new tenant relation given the required user id’s.

Example URI

POST https://api.c-tip.com/v1/tenant/1/user?sync=true
URI Parameters
HideShow
tenantId
integer (required) Example: 1

Id of a tenant

sync
bool (optional) Example: true

Determines whether data is thrown away and attached or attached

Request
HideShow
Body
{
  "data": [
    "1",
    "2",
    "3"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array with user id's"
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

Delete an existing tenant user relation
DELETE/tenant/{tenantId}/user{?sync}

Example URI

DELETE https://api.c-tip.com/v1/tenant/1/user?sync=true
URI Parameters
HideShow
tenantId
integer (required) Example: 1

Id of a tenant

sync
bool (optional) Example: true

Determines whether data is thrown away and attached or attached

Request
HideShow
Body
{
  "data": [
    "1",
    "2",
    "3"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array with user id's"
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json

Users

All calls for user management

User list

Get a list of users

Get users
GET/user{?perPage}

Get a list of users.

Example URI

GET https://api.c-tip.com/v1/user?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "primary_tenant_id": 2,
      "name": "John Doe",
      "email": "john@rapide.software",
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

Create new user
POST/user{?perPage}

Create a new user with the required parameters.

New users

New users are coupled to your current tenant.

Example URI

POST https://api.c-tip.com/v1/user?perPage=25
URI Parameters
HideShow
perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Request
HideShow
Body
{
  "data": {
    "primary_tenant_id": 2,
    "name": "John Doe",
    "email": "john@rapide.software"
  },
  "auth": {
    "accessor_type": "user",
    "access_level": 7,
    "accessor_id": 1
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "primary_tenant_id": {
          "type": "number",
          "description": "Id of primary tenant"
        },
        "name": {
          "type": "string",
          "description": "Name of the user"
        },
        "email": {
          "type": "string",
          "description": "Email address of the user"
        }
      },
      "required": [
        "primary_tenant_id",
        "name",
        "email"
      ]
    },
    "auth": {
      "type": "object",
      "properties": {
        "accessor_type": {
          "enum": [
            "user",
            "role",
            "tenant"
          ],
          "description": "Type of authorization"
        },
        "access_level": {
          "type": "number",
          "description": "Accesslevel bit (read,write,full)"
        },
        "accessor_id": {
          "type": "number",
          "description": "Identifier of accessor type"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of stored data (can be empty on array inserts)"
    }
  }
}

User

Get a specific users

Get User
GET/user/{id}

Get a user.

Example URI

GET https://api.c-tip.com/v1/user/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific user

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "primary_tenant_id": 2,
    "name": "John Doe",
    "email": "john@rapide.software",
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "User identifier"
        },
        "primary_tenant_id": {
          "type": "number",
          "description": "Id of primary tenant"
        },
        "name": {
          "type": "string",
          "description": "Name of the user"
        },
        "email": {
          "type": "string",
          "description": "Email address of the user"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of user creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last user update"
        }
      }
    }
  }
}

Update an existing user
PUT/user/{id}

Update a user

Example URI

PUT https://api.c-tip.com/v1/user/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific user

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "primary_tenant_id": 2,
    "name": "John Doe",
    "email": "john@rapide.software"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "User identifier"
        },
        "primary_tenant_id": {
          "type": "number",
          "description": "Id of primary tenant"
        },
        "name": {
          "type": "string",
          "description": "Name of the user"
        },
        "email": {
          "type": "string",
          "description": "Email address of the user"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Patch an existing user
PATCH/user/{id}

Patch a user

Example URI

PATCH https://api.c-tip.com/v1/user/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific user

Request
HideShow
Body
{
  "data": {
    "id": 1,
    "primary_tenant_id": 2,
    "name": "John Doe",
    "email": "john@rapide.software"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "User identifier"
        },
        "primary_tenant_id": {
          "type": "number",
          "description": "Id of primary tenant"
        },
        "name": {
          "type": "string",
          "description": "Name of the user"
        },
        "email": {
          "type": "string",
          "description": "Email address of the user"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of updated data (can be empty on array inserts)"
    }
  }
}

Delete an existing user
DELETE/user/{id}

Delete a user

Example URI

DELETE https://api.c-tip.com/v1/user/1
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific user

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "id": "1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success true or false"
    },
    "id": {
      "type": "string",
      "description": "Id of deleted data (can be empty on array inserts)"
    }
  }
}

UserTenants

All calls for userTenant management

User list

Get a list of root tenants based on a user id

Get tenants
GET/user/{id}/tenant{?perPage}

Get a list of tenants.

Example URI

GET https://api.c-tip.com/v1/user/1/tenant?perPage=25
URI Parameters
HideShow
id
integer (required) Example: 1

Id of a specific user

perPage
integer (optional) Default: 15 Example: 25

The maximum number of users to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "parent_id": 2,
      "name": "Office B.V.",
      "created_at": 1449143207,
      "updated_at": 1449143207
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Object on this page"
            },
            "per_page": {
              "type": "number",
              "description": "Object per page"
            },
            "current": {
              "type": "number",
              "description": "Current page number"
            },
            "total_pages": {
              "type": "number",
              "description": "Total number of pages"
            },
            "links": {
              "description": "Array of meta links"
            }
          }
        }
      }
    }
  }
}

User

Get a specific tenant based on a user

Get Tenant
GET/user/{user_id}/tenant/{tenant_id}

Get a tenant.

Example URI

GET https://api.c-tip.com/v1/user/1/tenant/1
URI Parameters
HideShow
user_id
integer (required) Example: 1

Id of a specific user

tenant_id
integer (required) Example: 1

Id of a specific tenant

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "parent_id": 2,
    "name": "Office B.V.",
    "created_at": 1449143207,
    "updated_at": 1449143207
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Tenant identifier"
        },
        "parent_id": {
          "type": "number",
          "description": "Id of the parent tenant, null means this is a root tenant"
        },
        "name": {
          "type": "string",
          "description": "Name of the tenant"
        },
        "created_at": {
          "type": "number",
          "description": "Timestamp of tenant creation date"
        },
        "updated_at": {
          "type": "number",
          "description": "Timestamp of last tenant update"
        }
      }
    }
  }
}

Generated by aglio on 28 May 2021