GET v1/Policy/{PolicyNumber}/AmendmentNumbersAndReasons/{PolicyFunction}

Get available amendment numbers and amendment reasons for a policy

Request Information

URI Parameters

Name	Description	Type	Additional information
PolicyNumber		string	Required
PolicyFunction	policy function category to lookup configured amendments for	PolicyFunctionTypeCustomEnum	Required

Body Parameters

None.

Response Information

Resource Description

Get available amendment numbers and amendment reasons for a policy

Collection of AmendmentInfoOutput

Name	Description	Type	Additional information
AmendmentId		integer	None.
AmendmentNumber	Used as input to policy amendment APIs like DoNotRenew and ReverseDoNotRenew	integer	None.
Description		string	None.
Reasons		Collection of AmendmentReasonOutput	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AmendmentId": 1,
    "AmendmentNumber": 1,
    "Description": "sample string 2",
    "Reasons": [
      {
        "ReasonId": 1,
        "Description": "sample string 2",
        "OutputFormat": "sample string 3",
        "AllowsFreeFormReason": true
      },
      {
        "ReasonId": 1,
        "Description": "sample string 2",
        "OutputFormat": "sample string 3",
        "AllowsFreeFormReason": true
      }
    ]
  },
  {
    "AmendmentId": 1,
    "AmendmentNumber": 1,
    "Description": "sample string 2",
    "Reasons": [
      {
        "ReasonId": 1,
        "Description": "sample string 2",
        "OutputFormat": "sample string 3",
        "AllowsFreeFormReason": true
      },
      {
        "ReasonId": 1,
        "Description": "sample string 2",
        "OutputFormat": "sample string 3",
        "AllowsFreeFormReason": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfAmendmentInfoOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <AmendmentInfoOutput>
    <AmendmentId>1</AmendmentId>
    <AmendmentNumber>1</AmendmentNumber>
    <Description>sample string 2</Description>
    <Reasons>
      <AmendmentReasonOutput>
        <AllowsFreeFormReason>true</AllowsFreeFormReason>
        <Description>sample string 2</Description>
        <OutputFormat>sample string 3</OutputFormat>
        <ReasonId>1</ReasonId>
      </AmendmentReasonOutput>
      <AmendmentReasonOutput>
        <AllowsFreeFormReason>true</AllowsFreeFormReason>
        <Description>sample string 2</Description>
        <OutputFormat>sample string 3</OutputFormat>
        <ReasonId>1</ReasonId>
      </AmendmentReasonOutput>
    </Reasons>
  </AmendmentInfoOutput>
  <AmendmentInfoOutput>
    <AmendmentId>1</AmendmentId>
    <AmendmentNumber>1</AmendmentNumber>
    <Description>sample string 2</Description>
    <Reasons>
      <AmendmentReasonOutput>
        <AllowsFreeFormReason>true</AllowsFreeFormReason>
        <Description>sample string 2</Description>
        <OutputFormat>sample string 3</OutputFormat>
        <ReasonId>1</ReasonId>
      </AmendmentReasonOutput>
      <AmendmentReasonOutput>
        <AllowsFreeFormReason>true</AllowsFreeFormReason>
        <Description>sample string 2</Description>
        <OutputFormat>sample string 3</OutputFormat>
        <ReasonId>1</ReasonId>
      </AmendmentReasonOutput>
    </Reasons>
  </AmendmentInfoOutput>
</ArrayOfAmendmentInfoOutput>