POST

apiportal/v1/Consent

No documentation available.

Request Information

Roles

Vendor_APIClient

URI Parameters

None.

Body Parameters

Collection of spiConsentRequest

Name	Type	Additional information
ID	integer	None.
ConsentCode	string	None.
ActiveFlag	boolean	None.
ConsentGivenBy	integer	None.
ConsentGivenDate	date	None.
ConsentExpiryDate	date	None.
ConsentRefusalComment	string	None.

Request Formats

[
  {
    "ID": 1,
    "ConsentCode": "sample string 2",
    "ActiveFlag": true,
    "ConsentGivenBy": 4,
    "ConsentGivenDate": "2025-12-14T11:29:07.0480192+10:30",
    "ConsentExpiryDate": "2025-12-14T11:29:07.0480192+10:30",
    "ConsentRefusalComment": "sample string 5"
  },
  {
    "ID": 1,
    "ConsentCode": "sample string 2",
    "ActiveFlag": true,
    "ConsentGivenBy": 4,
    "ConsentGivenDate": "2025-12-14T11:29:07.0480192+10:30",
    "ConsentExpiryDate": "2025-12-14T11:29:07.0480192+10:30",
    "ConsentRefusalComment": "sample string 5"
  }
]

<ArrayOfspiConsentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <spiConsentRequest>
    <ActiveFlag>true</ActiveFlag>
    <ConsentCode>sample string 2</ConsentCode>
    <ConsentExpiryDate>2025-12-14T11:29:07.0480192+10:30</ConsentExpiryDate>
    <ConsentGivenBy>4</ConsentGivenBy>
    <ConsentGivenDate>2025-12-14T11:29:07.0480192+10:30</ConsentGivenDate>
    <ConsentRefusalComment>sample string 5</ConsentRefusalComment>
    <ID>1</ID>
  </spiConsentRequest>
  <spiConsentRequest>
    <ActiveFlag>true</ActiveFlag>
    <ConsentCode>sample string 2</ConsentCode>
    <ConsentExpiryDate>2025-12-14T11:29:07.0480192+10:30</ConsentExpiryDate>
    <ConsentGivenBy>4</ConsentGivenBy>
    <ConsentGivenDate>2025-12-14T11:29:07.0480192+10:30</ConsentGivenDate>
    <ConsentRefusalComment>sample string 5</ConsentRefusalComment>
    <ID>1</ID>
  </spiConsentRequest>
</ArrayOfspiConsentRequest>

Sample not available.

Response Information

Resource Description

Collection of ChangeEntitySeqRespModel

Name	Description	Type	Additional information
RowNum		integer	None.
Result		ChangeEntitySeqModel	None.

[
  {
    "RowNum": 1,
    "Result": {
      "EntitySeq": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  },
  {
    "RowNum": 1,
    "Result": {
      "EntitySeq": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  }
]

<ArrayOfChangeEntitySeqRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <ChangeEntitySeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <EntitySeq>1</EntitySeq>
    </Result>
    <RowNum>1</RowNum>
  </ChangeEntitySeqRespModel>
  <ChangeEntitySeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <EntitySeq>1</EntitySeq>
    </Result>
    <RowNum>1</RowNum>
  </ChangeEntitySeqRespModel>
</ArrayOfChangeEntitySeqRespModel>