Integrations

Gets the iSAMS integration configuration for an organisation.

get

/api/v1/Integrations/isams/{organisationId}

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

organisationIdinteger · int32Required

Organisation identifier (route segment).

Responses

200

OK

application/json

orgIdstring · nullableOptional

importEnabledbooleanOptional

urlstring · nullableOptional

parentContactTypesstring[] · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Integrations/isams/{organisationId}

GET /api/v1/Integrations/isams/{organisationId} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "orgId": "text",
  "importEnabled": true,
  "url": "text",
  "parentContactTypes": [
    "text"
  ],
  "importFlags": {
    "allMergesCorrespondenceOnly": true,
    "billingOrAllMergesOnly": true,
    "ignoreForms": true,
    "ignoreHouses": true,
    "ignoreSubjects": true,
    "ignoreYears": true,
    "parentalResponsibilityOnly": true
  }
}

Updates one or more iSAMS integration configuration settings for an organisation.

patch

/api/v1/Integrations/isams/{organisationId}

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

organisationIdinteger · int32Required

Organisation identifier (route segment).

Body

importEnabledboolean · nullableOptional

urlstring · nullableOptional

parentContactTypesstring[] · nullableOptional

Responses

200

OK

application/json

orgIdstring · nullableOptional

importEnabledbooleanOptional

urlstring · nullableOptional

parentContactTypesstring[] · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch/api/v1/Integrations/isams/{organisationId}

PATCH /api/v1/Integrations/isams/{organisationId} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "importEnabled": true,
  "url": "text",
  "parentContactTypes": [
    "text"
  ],
  "importFlags": {
    "allMergesCorrespondenceOnly": true,
    "billingOrAllMergesOnly": true,
    "ignoreForms": true,
    "ignoreHouses": true,
    "ignoreSubjects": true,
    "ignoreYears": true,
    "parentalResponsibilityOnly": true
  }
}

{
  "orgId": "text",
  "importEnabled": true,
  "url": "text",
  "parentContactTypes": [
    "text"
  ],
  "importFlags": {
    "allMergesCorrespondenceOnly": true,
    "billingOrAllMergesOnly": true,
    "ignoreForms": true,
    "ignoreHouses": true,
    "ignoreSubjects": true,
    "ignoreYears": true,
    "parentalResponsibilityOnly": true
  }
}