routes

Current New
Method Path Schema Method Path Schema Change required Deprecated

POST /users/activate { POST /users/activate { Yes No

type: "object", type: "object",
properties: { properties: {
body: { body: {
type: "object", type: "object",
properties: { properties: {
cognitoUserId: { type: "string" }, connectId: { type: "string" },
connectUserId: { type: "string" }, connectNumber: { type: "string" },
}, },
required: ["cognitoUserId", required: ["connectId", “connectNumber"],
"connectUserId"], },
}, },
}, }
}
POST /users/{cognitoUserId}/points/adjustment { POST /users/{connectId}/points/adjustment{ Yes No
type: "object", type: "object",
properties: { properties: {
body: { body: {
type: "object", type: "object",
properties: { properties: {
value: { type: "number" }, value: { type: "number" },
reason: { type: "string" }, reason: { type: "string" },
salesforceAdminUserId: { type: salesforceAdminUserId: { type: "string" },
"string" }, },
}, required: ["value", "reason"],
required: ["value", "reason"], },
}, },
}, }
}

POST /point-adjustments { POST /point-adjustments { Yes No

type: "object", type: "object",
properties: { properties: {
body: { body: {
type: "object", type: "object",
properties: { properties: {
value: { type: "number" }, value: { type: "number" },
reason: { type: "string" }, reason: { type: "string" },
salesforceAdminUserId: { type: salesforceAdminUserId: { type: "string" },
"string" }, },
}, required: ["value", "reason"],
required: ["value", "reason"], },
}, params: {
params: { type: "object",
type: "object", properties: {
properties: { connectId: { type: "string" },
cognitoUserId: { type: "string" }, },
}, required: ["connectId"],
required: ["cognitoUserId"], },
}, },
}, }
}

POST /users/{cognitoUserId}/maxAi POST /users/{connectId}/maxAi Yes No

DELETE /users/{cognitoUserId}/maxAi DELETE /users/{connectId}/maxAi Yes No

DELETE /users/maxAi { DELETE /users/maxAi { Yes No
type: "object", type: "object",
properties: { properties: {
params: { params: {
type: "object", type: "object",
properties: { properties: {
installers: { installers: {
type: "array", type: "array",
items: { items: {
type: "object", type: "object",
properties: { properties: {
cognitoId: { type: "string" }, connectId: { type: "string" },
email: { type: "string" }, email: { type: "string" },
}, },
required: ["cognitoId", "email"], required: ["connectId", "email"],
}, },
}, },
}, },
required: ["installers"], required: ["installers"],
}, },
}, },
} }

POST /users/{cognitoUserId}/platinum POST /users/{connectId}/platinum Yes No

DELETE /users/{cognitoUserId}/platinum DELETE /users/{connectId}/platinum Yes No

POST /users/{cognitoUserId}/assets POST /users/{connectId}/assets Yes No

DELETE /users/{cognitoUserId}/assets DELETE /users/{connectId}/assets Yes No

GET /gasSafeEngineers/{businessRegistrationNumber} No No

POST /certificates/warranty No No
POST /certificates/gas-safe No No

POST /getToken No No
POST /users/{cognitoUserId}/band/override No Yes

POST /users/{cognitoUserId}/warranty/override No Yes

PATCH /users/{cognitoUserId}/warranty/override/{overrideId} No Yes

DELETE /users/{cognitoUserId}/warranty/override/{overrideId} No Yes

POST /users/{cognitoUserId}/points/override No Yes

DELETE /users/{cognitoUserId}/points/override/{overrideId} No Yes