Role configurations

Get role configurations

get

Retrieves role configurations for an appointment type

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

appointmentTypeIdstringRequiredPattern: [^\/#\?]+?

Query parameters

rolestringRequired

Responses

200Success

application/json

get

/api/service-provider-scheduling/{appointmentTypeId}/role-configurations

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/{appointmentTypeId}/role-configurations?role=text HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 1,
    "appointmentTypeId": 2,
    "locationType": "GOOGLE_MAPS",
    "durationInMinutes": 30,
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 10,
    "countPerRole": 1,
    "role": "CLIENT_MANAGER",
    "overBookingLimit": 2,
    "subRoleIds": [
      1,
      2
    ]
  }
]

Create role configuration

post

Creates role configurations for an appointment type

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

appointmentTypeIdstringRequiredPattern: [^\/#\?]+?

Bodyobject[]

application/json

object[]Optional

Responses

200Success

application/json

post

/api/service-provider-scheduling/{appointmentTypeId}/role-configurations

HTTPcURLJavaScriptPython

POST /api/service-provider-scheduling/{appointmentTypeId}/role-configurations HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

200Success

{
  "count": 10
}

Bulk update role configurations

put

Updates multiple role configurations

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Bodyobject[]

application/json

object[]Optional

Responses

200Success

application/json

put

/api/service-provider-scheduling/role-configurations

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/role-configurations HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

200Success

[
  {
    "id": 1,
    "appointmentTypeId": 2,
    "locationType": "GOOGLE_MAPS",
    "durationInMinutes": 30,
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 10,
    "countPerRole": 1,
    "role": "CLIENT_MANAGER",
    "overBookingLimit": 2,
    "subRoleIds": [
      1,
      2
    ]
  }
]

Bulk delete role configurations

delete

Deletes multiple role configurations

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idobject[]RequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/service-provider-scheduling/role-configurations/{id}

HTTPcURLJavaScriptPython

DELETE /api/service-provider-scheduling/role-configurations/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "message": "Record inserted successfully!"
}

Update role configuration

put

Updates a specific role configuration for an appointment type

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

appointmentTypeIdstringRequiredPattern: [^\/#\?]+?

idstringRequiredPattern: [^\/#\?]+?

Body

application/json

idnumberOptional

locationTypestring · enumOptionalPossible values:

appointmentTypeIdnumberOptional

durationInMinutesnumberOptional

maximumAppointmentsPerDaynumberOptional

maximumAppointmentsPerWeeknumberOptional

countPerRolenumberOptional

rolestring · enumOptionalPossible values:

overBookingLimitnumberOptional

Responses

200Success

application/json

put

/api/service-provider-scheduling/{appointmentTypeId}/role-configurations/{id}

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/{appointmentTypeId}/role-configurations/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "id": 1,
  "locationType": "NONE",
  "appointmentTypeId": 1,
  "durationInMinutes": 1,
  "maximumAppointmentsPerDay": 1,
  "maximumAppointmentsPerWeek": 1,
  "countPerRole": 1,
  "role": "OWNER",
  "overBookingLimit": 1,
  "subRoleIds": []
}

200Success

{
  "id": 1,
  "appointmentTypeId": 2,
  "locationType": "GOOGLE_MAPS",
  "durationInMinutes": 30,
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 10,
  "countPerRole": 1,
  "role": "CLIENT_MANAGER",
  "overBookingLimit": 2,
  "subRoleIds": [
    1,
    2
  ]
}

Delete role configuration

delete

Deletes a specific role configuration for an appointment type

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

appointmentTypeIdstringRequiredPattern: [^\/#\?]+?

idstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/service-provider-scheduling/{appointmentTypeId}/role-configurations/{id}

HTTPcURLJavaScriptPython

DELETE /api/service-provider-scheduling/{appointmentTypeId}/role-configurations/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "appointmentTypeId": 2,
  "locationType": "GOOGLE_MAPS",
  "durationInMinutes": 30,
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 10,
  "countPerRole": 1,
  "role": "CLIENT_MANAGER",
  "overBookingLimit": 2,
  "subRoleIds": [
    1,
    2
  ]
}