POST api/v1/cancelreasons/config

Retruns the Configuration for the current division with associations

Request Information

URI Parameters

None.

Body Parameters

CancelReasonConfigModel
NameDescriptionTypeAdditional information
Division

DivisionRequestModel

None.

Categories

Collection of CancelReasonCategoryRequestModel

None.

Associations

Collection of CancelReasonAssociationRequestModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Division": {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Level": "sample string 3",
    "Items": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Level": "sample string 3",
        "Coid": "sample string 4",
        "Items": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Level": "sample string 1",
            "Code": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Level": "sample string 1",
            "Code": "sample string 2"
          }
        ]
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Level": "sample string 3",
        "Coid": "sample string 4",
        "Items": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Level": "sample string 1",
            "Code": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Level": "sample string 1",
            "Code": "sample string 2"
          }
        ]
      }
    ]
  },
  "Categories": [
    {
      "CategoryId": 1,
      "Category": "sample string 2",
      "IsDisabled": true,
      "ExcludeFromReporting": true,
      "InUseCount": 5,
      "EnabledCount": 6,
      "IsSystem": true,
      "Reasons": [
        {
          "CategoryId": 1,
          "Category": "sample string 2",
          "ReasonId": 3,
          "Reason": "sample string 4",
          "IsDisabled": true,
          "ExcludeFromReporting": true,
          "InUseCount": 7,
          "EnabledCount": 8,
          "IsSystem": true,
          "IsExcludedFromStaffReports": true
        },
        {
          "CategoryId": 1,
          "Category": "sample string 2",
          "ReasonId": 3,
          "Reason": "sample string 4",
          "IsDisabled": true,
          "ExcludeFromReporting": true,
          "InUseCount": 7,
          "EnabledCount": 8,
          "IsSystem": true,
          "IsExcludedFromStaffReports": true
        }
      ]
    },
    {
      "CategoryId": 1,
      "Category": "sample string 2",
      "IsDisabled": true,
      "ExcludeFromReporting": true,
      "InUseCount": 5,
      "EnabledCount": 6,
      "IsSystem": true,
      "Reasons": [
        {
          "CategoryId": 1,
          "Category": "sample string 2",
          "ReasonId": 3,
          "Reason": "sample string 4",
          "IsDisabled": true,
          "ExcludeFromReporting": true,
          "InUseCount": 7,
          "EnabledCount": 8,
          "IsSystem": true,
          "IsExcludedFromStaffReports": true
        },
        {
          "CategoryId": 1,
          "Category": "sample string 2",
          "ReasonId": 3,
          "Reason": "sample string 4",
          "IsDisabled": true,
          "ExcludeFromReporting": true,
          "InUseCount": 7,
          "EnabledCount": 8,
          "IsSystem": true,
          "IsExcludedFromStaffReports": true
        }
      ]
    }
  ],
  "Associations": [
    {
      "Id": 1,
      "ReasonId": 2,
      "DepartmentId": 3,
      "IsAssociated": true
    },
    {
      "Id": 1,
      "ReasonId": 2,
      "DepartmentId": 3,
      "IsAssociated": true
    }
  ]
}

Response Information

Resource Description

ApiResponseModelOfCancelReasonConfigModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfCancelReasonConfigModel

None.

Errors

Collection of string

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PageSize": 1,
    "Page": 2,
    "TotalPages": 3,
    "TotalResults": 4,
    "Results": {
      "Division": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Level": "sample string 3",
        "Items": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Level": "sample string 3",
            "Coid": "sample string 4",
            "Items": [
              {
                "Id": "sample string 1",
                "Name": "sample string 2",
                "Level": "sample string 1",
                "Code": "sample string 2"
              },
              {
                "Id": "sample string 1",
                "Name": "sample string 2",
                "Level": "sample string 1",
                "Code": "sample string 2"
              }
            ]
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Level": "sample string 3",
            "Coid": "sample string 4",
            "Items": [
              {
                "Id": "sample string 1",
                "Name": "sample string 2",
                "Level": "sample string 1",
                "Code": "sample string 2"
              },
              {
                "Id": "sample string 1",
                "Name": "sample string 2",
                "Level": "sample string 1",
                "Code": "sample string 2"
              }
            ]
          }
        ]
      },
      "Categories": [
        {
          "CategoryId": 1,
          "Category": "sample string 2",
          "IsDisabled": true,
          "ExcludeFromReporting": true,
          "InUseCount": 5,
          "EnabledCount": 6,
          "IsSystem": true,
          "Reasons": [
            {
              "CategoryId": 1,
              "Category": "sample string 2",
              "ReasonId": 3,
              "Reason": "sample string 4",
              "IsDisabled": true,
              "ExcludeFromReporting": true,
              "InUseCount": 7,
              "EnabledCount": 8,
              "IsSystem": true,
              "IsExcludedFromStaffReports": true
            },
            {
              "CategoryId": 1,
              "Category": "sample string 2",
              "ReasonId": 3,
              "Reason": "sample string 4",
              "IsDisabled": true,
              "ExcludeFromReporting": true,
              "InUseCount": 7,
              "EnabledCount": 8,
              "IsSystem": true,
              "IsExcludedFromStaffReports": true
            }
          ]
        },
        {
          "CategoryId": 1,
          "Category": "sample string 2",
          "IsDisabled": true,
          "ExcludeFromReporting": true,
          "InUseCount": 5,
          "EnabledCount": 6,
          "IsSystem": true,
          "Reasons": [
            {
              "CategoryId": 1,
              "Category": "sample string 2",
              "ReasonId": 3,
              "Reason": "sample string 4",
              "IsDisabled": true,
              "ExcludeFromReporting": true,
              "InUseCount": 7,
              "EnabledCount": 8,
              "IsSystem": true,
              "IsExcludedFromStaffReports": true
            },
            {
              "CategoryId": 1,
              "Category": "sample string 2",
              "ReasonId": 3,
              "Reason": "sample string 4",
              "IsDisabled": true,
              "ExcludeFromReporting": true,
              "InUseCount": 7,
              "EnabledCount": 8,
              "IsSystem": true,
              "IsExcludedFromStaffReports": true
            }
          ]
        }
      ],
      "Associations": [
        {
          "Id": 1,
          "ReasonId": 2,
          "DepartmentId": 3,
          "IsAssociated": true
        },
        {
          "Id": 1,
          "ReasonId": 2,
          "DepartmentId": 3,
          "IsAssociated": true
        }
      ]
    }
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}