GET api/clients/{clientId}/credible-plan/get

Gets the active credible plans associated to a client.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	the id of the client to get the active plans from.	integer	Required

Body Parameters

None.

Response Information

Resource Description

An Http response message with the following status codes: 200 = success (includes the list of plans; this list can be empty), 400 = bad request (the request is malformed or with invalid data), 403 = forbidden (the employee doing the request is not valid), 404 = not found (this is returned when the supplied client Id can't be found.) 500 = something went wrong (the request was not processed).

CrediblePlanFull

Name	Type	Additional information
PlanData	Collection of CrediblePlan	None.
PlanSignatures	Collection of CrediblePlanSignature	None.
PlanExtendedFields	Collection of CrediblePlanElementExtendedField	None.
PlanElements	Collection of CrediblePlanElement	None.
PlanPastDocumentations	Collection of TzCrediblePlanSavedDocumentation	None.

Response Formats

application/json, text/json

Sample:

{
  "PlanData": [
    {
      "crediblePlanId": 1,
      "sourceCrediblePlanId": 1,
      "isSnapshot": true,
      "dateCreatedUtc": "2026-05-07T23:24:15.3716295-04:00",
      "dateUpdatedUtc": "2026-05-07T23:24:15.3716295-04:00",
      "previousCrediblePlanId": 1,
      "clientId": 1,
      "clientVisitId": 1,
      "clientVisitTempId": 1,
      "programDescription": "sample string 3",
      "active": true,
      "planMethodsId": 1,
      "planProgramId": 1,
      "planRuleSetId": 1,
      "planStructureId": 1,
      "planTemplateId": 1,
      "planTemplateName": "sample string 5",
      "isTemplate": true,
      "planTypeId": 1,
      "planType": "sample string 7",
      "planWileyId": 1,
      "targetDate": "2026-05-07T23:24:15.3716295-04:00",
      "startDate": "2026-05-07T23:24:15.3716295-04:00",
      "endDate": "2026-05-07T23:24:15.3716295-04:00",
      "approvalDate": "2026-05-07T23:24:15.3716295-04:00",
      "hasDocumentation": true,
      "updatedByEmployeeId": 1
    },
    {
      "crediblePlanId": 1,
      "sourceCrediblePlanId": 1,
      "isSnapshot": true,
      "dateCreatedUtc": "2026-05-07T23:24:15.3716295-04:00",
      "dateUpdatedUtc": "2026-05-07T23:24:15.3716295-04:00",
      "previousCrediblePlanId": 1,
      "clientId": 1,
      "clientVisitId": 1,
      "clientVisitTempId": 1,
      "programDescription": "sample string 3",
      "active": true,
      "planMethodsId": 1,
      "planProgramId": 1,
      "planRuleSetId": 1,
      "planStructureId": 1,
      "planTemplateId": 1,
      "planTemplateName": "sample string 5",
      "isTemplate": true,
      "planTypeId": 1,
      "planType": "sample string 7",
      "planWileyId": 1,
      "targetDate": "2026-05-07T23:24:15.3716295-04:00",
      "startDate": "2026-05-07T23:24:15.3716295-04:00",
      "endDate": "2026-05-07T23:24:15.3716295-04:00",
      "approvalDate": "2026-05-07T23:24:15.3716295-04:00",
      "hasDocumentation": true,
      "updatedByEmployeeId": 1
    }
  ],
  "PlanSignatures": [
    {
      "signatureId": 1,
      "crediblePlanId": 2,
      "componentId": 1,
      "sourceSignatureId": 1,
      "sourceCrediblePlanId": 2,
      "sourceComponentId": 1,
      "signature": "sample string 3",
      "type": "sample string 4",
      "dateCreated": "2026-05-07T23:24:15.3716295-04:00",
      "dateUpdated": "2026-05-07T23:24:15.3716295-04:00",
      "label": "sample string 7",
      "printName": "sample string 8",
      "sortOrder": 9
    },
    {
      "signatureId": 1,
      "crediblePlanId": 2,
      "componentId": 1,
      "sourceSignatureId": 1,
      "sourceCrediblePlanId": 2,
      "sourceComponentId": 1,
      "signature": "sample string 3",
      "type": "sample string 4",
      "dateCreated": "2026-05-07T23:24:15.3716295-04:00",
      "dateUpdated": "2026-05-07T23:24:15.3716295-04:00",
      "label": "sample string 7",
      "printName": "sample string 8",
      "sortOrder": 9
    }
  ],
  "PlanExtendedFields": [
    {
      "crediblePlanId": 1,
      "componentId": 1,
      "componentExtendedFieldId": 1,
      "sourceCrediblePlanId": 1,
      "sourceComponentId": 1,
      "sourceComponentExtendedFieldId": 1,
      "extendedFieldId": 2,
      "extendedFieldValue": "sample string 3",
      "displayOrder": 6
    },
    {
      "crediblePlanId": 1,
      "componentId": 1,
      "componentExtendedFieldId": 1,
      "sourceCrediblePlanId": 1,
      "sourceComponentId": 1,
      "sourceComponentExtendedFieldId": 1,
      "extendedFieldId": 2,
      "extendedFieldValue": "sample string 3",
      "displayOrder": 6
    }
  ],
  "PlanElements": [
    {
      "crediblePlanId": 1,
      "componentId": 1,
      "sourceCrediblePlanId": 1,
      "sourceComponentId": 1,
      "parentId": 1,
      "previousComponentId": 1,
      "active": true,
      "allowSignatures": true,
      "childLabel": "sample string 3",
      "clientPriorityStatus": 1,
      "color": "sample string 4",
      "componentType": 1,
      "componentTypeId": 1,
      "dateCreated": "2026-05-07T23:24:15.3716295-04:00",
      "dateUpdated": "2026-05-07T23:24:15.3716295-04:00",
      "updatedByEmpId": 1,
      "description": "sample string 5",
      "elementStatus": 1,
      "employeePriorityStatus": 1,
      "endDate": "2026-05-07T23:24:15.3716295-04:00",
      "freeTextDocumentation": true,
      "goalAchievementDate": "2026-05-07T23:24:15.3716295-04:00",
      "goalAchievementStatus": 1,
      "hasChildren": true,
      "hasElementStatus": true,
      "hasEndDate": true,
      "hasGoalAchievementStatus": true,
      "hasStartDate": true,
      "hasTargetDate": true,
      "label": "sample string 6",
      "displayOrder": 1,
      "priorityStatus": 1,
      "snomedCid": 1,
      "snomedFsn": "sample string 7",
      "startDate": "2026-05-07T23:24:15.3716295-04:00",
      "status": 1,
      "targetDate": "2026-05-07T23:24:15.3716295-04:00",
      "title": "sample string 8",
      "tooltip": "sample string 9",
      "wileyId": 1
    },
    {
      "crediblePlanId": 1,
      "componentId": 1,
      "sourceCrediblePlanId": 1,
      "sourceComponentId": 1,
      "parentId": 1,
      "previousComponentId": 1,
      "active": true,
      "allowSignatures": true,
      "childLabel": "sample string 3",
      "clientPriorityStatus": 1,
      "color": "sample string 4",
      "componentType": 1,
      "componentTypeId": 1,
      "dateCreated": "2026-05-07T23:24:15.3716295-04:00",
      "dateUpdated": "2026-05-07T23:24:15.3716295-04:00",
      "updatedByEmpId": 1,
      "description": "sample string 5",
      "elementStatus": 1,
      "employeePriorityStatus": 1,
      "endDate": "2026-05-07T23:24:15.3716295-04:00",
      "freeTextDocumentation": true,
      "goalAchievementDate": "2026-05-07T23:24:15.3716295-04:00",
      "goalAchievementStatus": 1,
      "hasChildren": true,
      "hasElementStatus": true,
      "hasEndDate": true,
      "hasGoalAchievementStatus": true,
      "hasStartDate": true,
      "hasTargetDate": true,
      "label": "sample string 6",
      "displayOrder": 1,
      "priorityStatus": 1,
      "snomedCid": 1,
      "snomedFsn": "sample string 7",
      "startDate": "2026-05-07T23:24:15.3716295-04:00",
      "status": 1,
      "targetDate": "2026-05-07T23:24:15.3716295-04:00",
      "title": "sample string 8",
      "tooltip": "sample string 9",
      "wileyId": 1
    }
  ],
  "PlanPastDocumentations": null
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'SourceId' in type 'CWI.Mobile.Domain.Models.CrediblePlan.CrediblePlan'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'SourceId' in type 'CWI.Mobile.Domain.Models.CrediblePlan.CrediblePlan'.