Seccl - Store an adviser node association

POST /api/v1/addons/seccl/{addon}/associate-node

Headers

Path parameters

application/json

Body Required

  • associations array[string] Required

    Associations to be created. Each association should have adviser_uuid and SECCL node_ids.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • type string

      Lookup type

    • lookupable_type string

      The model type you are looking up against

    • lookupable_uuid string

      The UUID of the model of the lookup value you are looking up against

    • lookupable_value string

      The description of the model of the lookup value you are looking up against

    • lookup_value string

      A string of a lookup value you are looking up against

    • returnable_type string

      The model type that was found by this lookup

    • returnable_uuid string

      The model UUID that was found by this lookup

    • returnable_value string

      The description of the model that was found by this lookup

    • return_string string

      The return value that was found by this lookup

    • return_json object

      The return value that was found by this lookup

      Additional properties are allowed.

    • return_float number

      The return value that was found by this lookup
POST /api/v1/addons/seccl/{addon}/associate-node 
curl \
 -X POST https://api.plannrcrm.com/api/v1/addons/seccl/addon/associate-node \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"associations":[{"node_ids":{"type":"array","example":["1234","321"],"required":true,"description":"SECCL Node IDs"},"adviser_uuid":{"type":"string","example":"03c38a45-e691-42c9-b128-365c7b52f3eb","required":true,"description":"Adviser UUID"}}]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "associations": [
    {
      "node_ids": {
        "type": "array",
        "example": [
          "1234",
          "321"
        ],
        "required": true,
        "description": "SECCL Node IDs"
      },
      "adviser_uuid": {
        "type": "string",
        "example": "03c38a45-e691-42c9-b128-365c7b52f3eb",
        "required": true,
        "description": "Adviser UUID"
      }
    }
  ]
}
Response examples (200) 
{
  "type": "provider_statement_mapping",
  "uuid": "c1be78c6-d0a7-49f0-8f44-0efe51e8bc3c",
  "created_at": "2024-11-20T13:24:04+00:00",
  "updated_at": "2024-11-20T13:24:04+00:00",
  "return_json": {
    "key_1": "value_1",
    "key_2": "value_2"
  },
  "lookup_value": "zAbWeFVJ:Bloggs J",
  "return_float": 70.35,
  "return_string": "Consectetur officia labore",
  "lookupable_type": "provider",
  "lookupable_uuid": "e6559168-dba0-4c84-b453-33ff6e23665c",
  "returnable_type": "plan",
  "returnable_uuid": "a08b526b-7658-4d4a-80e5-83cd8be7e819",
  "lookupable_value": "J Bloggs Plan",
  "returnable_value": "example"
}