casavi Community API (1.0.0)

Download OpenAPI specification:Download

casavi

Manager API here

Access to functionality that is used by community apps (web & hybrid)

Authentication

We support two authorization methods: via cookie and open id connect. Just follow the normal open id authorization flow using this discovery endpoint /.well-known/openid-configuration

Bearer

Security Scheme Type API Key
Header parameter name: Authorization

Cookie

Security Scheme Type API Key
Cookie parameter name: user_session

Open ID Connect

<no summary>

Request Body schema: application/json
firstName
string
lastName
string
email
string
clientId
string
inviteCode
string
providerKey
string

The provider key is used to allow the user to login afterwards using the specified open id connect provider. Only known providers are allowed here. Ask your technical contact or for the required value in your case.

sub
string

An optional user identifier to be used for that user (see providerKey attribute). If not specified the reference id of the contact will be used.

Responses

Request samples

Content type
application/json
{
  • "firstName": "Max",
  • "lastName": "Mustermann",
  • "email": "max@mustermann.com",
  • "clientId": "foobar",
  • "inviteCode": "9ug2ef6",
  • "providerKey": "somekey",
  • "sub": "u00001"
}

Response samples

Content type
application/json
{
  • "oidcIdToken": "jg814jti34",
  • "oidcAccessToken": "mginugz156124",
  • "oidcRefreshToken": "gnujnjsqq41",
  • "contactExtRef": "c-1235"
}

Endpoint to retrieve all information about the cas

Endpoint to retrieve all information about the casavi open id provider.

Responses

Tickets

Ticket system routes

<no summary>

Authorizations:
query Parameters
community_id
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

<no summary>

Authorizations:
Request Body schema: application/json
communityId
integer
object

Maps fields to values. Keys are the ids of the fields (from the ticket types), the value is the user input. File uploads are also added here (see example)

ticketTypeId
integer

Reference to the ticket type for this new ticket

unitId
integer

Reference to the unit for which this ticket will be created. See /api/v1/units for information on how to get all units for the user

Responses

Request samples

Content type
application/json
{
  • "communityId": 0,
  • "fields":
    {
    },
  • "ticketTypeId": 2341,
  • "unitId": 433
}

<no summary>

Authorizations:
path Parameters
ticket_id
required
integer
Request Body schema: application/json
Array of objects (Upload)
text
string

Responses

Request samples

Content type
application/json
{
  • "attachments":
    [
    ],
  • "text": "Lorem ipsum dolor sit amut"
}

<no summary>

Authorizations:
path Parameters
ticket_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "AssignedTo":
    {
    },
  • "Community":
    {
    },
  • "Contact":
    {