POST

apiportal/v1/MedicalImmunisation

No documentation available.

Request Information

Roles

Vendor_APIClient

URI Parameters

None.

Body Parameters

Collection of spiMedicalImmunisation

Name	Type	Additional information
ID	integer	None.
ImmunisationCode	string	None.
ActiveFlag	boolean	None.
VaccineBrandCode	string	None.
BatchNo	string	None.
AdministeredBy	string	None.
AdministeredDate	date	None.
ImmunityEndDate	date	None.
ImmunisationDescription	string	None.

Request Formats

[
  {
    "ID": 1,
    "ImmunisationCode": "sample string 2",
    "ActiveFlag": true,
    "VaccineBrandCode": "sample string 3",
    "BatchNo": "sample string 4",
    "AdministeredBy": "sample string 5",
    "AdministeredDate": "2025-12-14T20:52:00.3350307+10:30",
    "ImmunityEndDate": "2025-12-14T20:52:00.3350307+10:30",
    "ImmunisationDescription": "sample string 6"
  },
  {
    "ID": 1,
    "ImmunisationCode": "sample string 2",
    "ActiveFlag": true,
    "VaccineBrandCode": "sample string 3",
    "BatchNo": "sample string 4",
    "AdministeredBy": "sample string 5",
    "AdministeredDate": "2025-12-14T20:52:00.3350307+10:30",
    "ImmunityEndDate": "2025-12-14T20:52:00.3350307+10:30",
    "ImmunisationDescription": "sample string 6"
  }
]

<ArrayOfspiMedicalImmunisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <spiMedicalImmunisation>
    <ActiveFlag>true</ActiveFlag>
    <AdministeredBy>sample string 5</AdministeredBy>
    <AdministeredDate>2025-12-14T20:52:00.3350307+10:30</AdministeredDate>
    <BatchNo>sample string 4</BatchNo>
    <ID>1</ID>
    <ImmunisationCode>sample string 2</ImmunisationCode>
    <ImmunisationDescription>sample string 6</ImmunisationDescription>
    <ImmunityEndDate>2025-12-14T20:52:00.3350307+10:30</ImmunityEndDate>
    <VaccineBrandCode>sample string 3</VaccineBrandCode>
  </spiMedicalImmunisation>
  <spiMedicalImmunisation>
    <ActiveFlag>true</ActiveFlag>
    <AdministeredBy>sample string 5</AdministeredBy>
    <AdministeredDate>2025-12-14T20:52:00.3350307+10:30</AdministeredDate>
    <BatchNo>sample string 4</BatchNo>
    <ID>1</ID>
    <ImmunisationCode>sample string 2</ImmunisationCode>
    <ImmunisationDescription>sample string 6</ImmunisationDescription>
    <ImmunityEndDate>2025-12-14T20:52:00.3350307+10:30</ImmunityEndDate>
    <VaccineBrandCode>sample string 3</VaccineBrandCode>
  </spiMedicalImmunisation>
</ArrayOfspiMedicalImmunisation>

Sample not available.

Response Information

Resource Description

Collection of CreateMedicalImmunisationRespModel

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

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

<ArrayOfCreateMedicalImmunisationRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <CreateMedicalImmunisationRespModel>
    <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>
      <MedicalImmunisations>
        <_CreateMedicalImmunisationModel>
          <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>
          <ComboDrugSeq>1</ComboDrugSeq>
        </_CreateMedicalImmunisationModel>
        <_CreateMedicalImmunisationModel>
          <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>
          <ComboDrugSeq>1</ComboDrugSeq>
        </_CreateMedicalImmunisationModel>
      </MedicalImmunisations>
    </Result>
    <RowNum>1</RowNum>
  </CreateMedicalImmunisationRespModel>
  <CreateMedicalImmunisationRespModel>
    <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>
      <MedicalImmunisations>
        <_CreateMedicalImmunisationModel>
          <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>
          <ComboDrugSeq>1</ComboDrugSeq>
        </_CreateMedicalImmunisationModel>
        <_CreateMedicalImmunisationModel>
          <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>
          <ComboDrugSeq>1</ComboDrugSeq>
        </_CreateMedicalImmunisationModel>
      </MedicalImmunisations>
    </Result>
    <RowNum>1</RowNum>
  </CreateMedicalImmunisationRespModel>
</ArrayOfCreateMedicalImmunisationRespModel>