Note

Quick Reference

Method

Endpoint

Description

GET

/api/note

POST

/api/note

PUT

/api/note/{id}

GET

/api/note/suggestUsers

GET /api/note

Parameters:

Query Parameters:

  • category (array, query): No description available

  • jobId (string, query): No description available

  • contactId (integer, query): No description available

  • companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/note"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

POST /api/note

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/note"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

PUT /api/note/{id}

Parameters:

Path Parameters:

  • id (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/note/{id}"
,
    id=789e0123-e89b-12d3-a456-426614174002
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{}

GET /api/note/suggestUsers

Parameters:

Query Parameters:

  • SearchKey (string, query) (required): No description available

  • JobFranchiseeId (string, query): No description available

  • CompanyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/note/suggestUsers"
,
    SearchKey="example-value"

)

# Process the response
print(response)

Sample Response:

1[]