POST api/care/credible-plan/save

saves a credible plan to partners database. used for synchronization during edits and add new.

Request Information

URI Parameters

None.

Body Parameters

a full credible plan flat object.

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

Request Formats

application/json, text/json

Sample:

{
  "PlanData": {
    "mobileCrediblePlanId": 1,
    "crediblePlanId": 1,
    "sourceCrediblePlanId": 1,
    "isSnapshot": true,
    "dateCreatedUtc": "2026-05-05T07:16:50.3261771-04:00",
    "dateUpdatedUtc": "2026-05-05T07:16:50.3261771-04:00",
    "previousCrediblePlanId": 1,
    "clientId": 1,
    "clientVisitId": 1,
    "clientVisitTempId": 1,
    "programDescription": "sample string 4",
    "active": true,
    "planMethodsId": 1,
    "planProgramId": 1,
    "planRuleSetId": 1,
    "planStructureId": 1,
    "planTemplateId": 1,
    "planTemplateName": "sample string 6",
    "isTemplate": true,
    "planTypeId": 1,
    "planType": "sample string 8",
    "planWileyId": 1,
    "targetDate": "2026-05-05T07:16:50.3261771-04:00",
    "startDate": "2026-05-05T07:16:50.3261771-04:00",
    "endDate": "2026-05-05T07:16:50.3261771-04:00",
    "approvalDate": "2026-05-05T07:16:50.3261771-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-05T07:16:50.3261771-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3261771-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-05T07:16:50.3261771-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3261771-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-05T07:16:50.3261771-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3261771-04:00",
      "updatedByEmpId": 1,
      "description": "sample string 5",
      "elementStatus": 1,
      "employeePriorityStatus": 1,
      "endDate": "2026-05-05T07:16:50.3261771-04:00",
      "freeTextDocumentation": true,
      "goalAchievementDate": "2026-05-05T07:16:50.3261771-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-05T07:16:50.3261771-04:00",
      "status": 1,
      "targetDate": "2026-05-05T07:16:50.3261771-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-05T07:16:50.3261771-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3261771-04:00",
      "updatedByEmpId": 1,
      "description": "sample string 5",
      "elementStatus": 1,
      "employeePriorityStatus": 1,
      "endDate": "2026-05-05T07:16:50.3261771-04:00",
      "freeTextDocumentation": true,
      "goalAchievementDate": "2026-05-05T07:16:50.3261771-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-05T07:16:50.3261771-04:00",
      "status": 1,
      "targetDate": "2026-05-05T07:16:50.3261771-04:00",
      "title": "sample string 8",
      "tooltip": "sample string 9",
      "wileyId": 1
    }
  ],
  "PlanPastDocumentations": [
    {
      "id": 1,
      "crediblePlanId": 2,
      "componentId": 3,
      "sourceId": 1,
      "sourceCrediblePlanId": 2,
      "sourceComponentId": 3,
      "text": "sample string 6",
      "dateCreated": "2026-05-05T07:16:50.3261771-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3261771-04:00",
      "byEmployeeId": 1
    },
    {
      "id": 1,
      "crediblePlanId": 2,
      "componentId": 3,
      "sourceId": 1,
      "sourceCrediblePlanId": 2,
      "sourceComponentId": 3,
      "text": "sample string 6",
      "dateCreated": "2026-05-05T07:16:50.3261771-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3261771-04:00",
      "byEmployeeId": 1
    }
  ]
}

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'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SaveCareCrediblePlanRequest'.

Response Information

Resource Description

MobileCrediblePlanFull

Name	Type	Additional information
PlanData	Collection of MobileCrediblePlan	None.
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": [
    {
      "mobileCrediblePlanId": 1,
      "crediblePlanId": 1,
      "sourceCrediblePlanId": 1,
      "isSnapshot": true,
      "dateCreatedUtc": "2026-05-05T07:16:50.3581735-04:00",
      "dateUpdatedUtc": "2026-05-05T07:16:50.3581735-04:00",
      "previousCrediblePlanId": 1,
      "clientId": 1,
      "clientVisitId": 1,
      "clientVisitTempId": 1,
      "programDescription": "sample string 4",
      "active": true,
      "planMethodsId": 1,
      "planProgramId": 1,
      "planRuleSetId": 1,
      "planStructureId": 1,
      "planTemplateId": 1,
      "planTemplateName": "sample string 6",
      "isTemplate": true,
      "planTypeId": 1,
      "planType": "sample string 8",
      "planWileyId": 1,
      "targetDate": "2026-05-05T07:16:50.3581735-04:00",
      "startDate": "2026-05-05T07:16:50.3581735-04:00",
      "endDate": "2026-05-05T07:16:50.3581735-04:00",
      "approvalDate": "2026-05-05T07:16:50.3581735-04:00",
      "hasDocumentation": true,
      "updatedByEmployeeId": 1
    },
    {
      "mobileCrediblePlanId": 1,
      "crediblePlanId": 1,
      "sourceCrediblePlanId": 1,
      "isSnapshot": true,
      "dateCreatedUtc": "2026-05-05T07:16:50.3581735-04:00",
      "dateUpdatedUtc": "2026-05-05T07:16:50.3581735-04:00",
      "previousCrediblePlanId": 1,
      "clientId": 1,
      "clientVisitId": 1,
      "clientVisitTempId": 1,
      "programDescription": "sample string 4",
      "active": true,
      "planMethodsId": 1,
      "planProgramId": 1,
      "planRuleSetId": 1,
      "planStructureId": 1,
      "planTemplateId": 1,
      "planTemplateName": "sample string 6",
      "isTemplate": true,
      "planTypeId": 1,
      "planType": "sample string 8",
      "planWileyId": 1,
      "targetDate": "2026-05-05T07:16:50.3581735-04:00",
      "startDate": "2026-05-05T07:16:50.3581735-04:00",
      "endDate": "2026-05-05T07:16:50.3581735-04:00",
      "approvalDate": "2026-05-05T07:16:50.3581735-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-05T07:16:50.3581735-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3581735-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-05T07:16:50.3581735-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3581735-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-05T07:16:50.3581735-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3581735-04:00",
      "updatedByEmpId": 1,
      "description": "sample string 5",
      "elementStatus": 1,
      "employeePriorityStatus": 1,
      "endDate": "2026-05-05T07:16:50.3581735-04:00",
      "freeTextDocumentation": true,
      "goalAchievementDate": "2026-05-05T07:16:50.3581735-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-05T07:16:50.3581735-04:00",
      "status": 1,
      "targetDate": "2026-05-05T07:16:50.3581735-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-05T07:16:50.3581735-04:00",
      "dateUpdated": "2026-05-05T07:16:50.3581735-04:00",
      "updatedByEmpId": 1,
      "description": "sample string 5",
      "elementStatus": 1,
      "employeePriorityStatus": 1,
      "endDate": "2026-05-05T07:16:50.3581735-04:00",
      "freeTextDocumentation": true,
      "goalAchievementDate": "2026-05-05T07:16:50.3581735-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-05T07:16:50.3581735-04:00",
      "status": 1,
      "targetDate": "2026-05-05T07:16:50.3581735-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: Type 'System.Collections.Generic.List`1[[CWI.Mobile.Domain.Models.CrediblePlan.CrediblePlan, CWI.Mobile.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfCrediblePlan:http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.Models.CrediblePlan' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Collections.Generic.List`1[[CWI.Mobile.Domain.Models.CrediblePlan.CrediblePlan, CWI.Mobile.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfCrediblePlan:http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.Models.CrediblePlan' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.