POST CareStatements/CareStatementBatch?validateOnly={validateOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
validateOnly

boolean

Default value is False

Body Parameters

CareStatementBatchDTO
NameDescriptionTypeAdditional information
CareStatementBatchID

integer

None.

Label

string

None.

Status

CareStatementBatchStatus

None.

GenerationDateUtc

date

None.

FromDateUtc

date

None.

ToDateUtc

date

None.

ClientIDs

Collection of integer

None.

AdmissionTypes

Collection of integer

None.

CareStatements

Collection of CareStatementDTO

None.

BUID

integer

None.

GroupID

integer

None.

SubGroupIDs

Collection of integer

None.

TriggeringUserID

integer

None.

TriggeringWorkerID

integer

None.

RecordState

RecordState

None.

ErrorLog

string

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "careStatementBatchID": 1,
  "label": "sample string 2",
  "status": 1,
  "generationDateUtc": "2024-12-04T08:16:44.4856069+00:00",
  "fromDateUtc": "2024-12-04T08:16:44.4856069+00:00",
  "toDateUtc": "2024-12-04T08:16:44.4856069+00:00",
  "clientIDs": [
    1,
    2
  ],
  "admissionTypes": [
    1,
    2
  ],
  "careStatements": [
    {
      "careStatementID": 1,
      "careStatementBatchID": 2,
      "clientID": 3,
      "buid": 4,
      "groupID": 5,
      "contactID": 1,
      "startDateUtc": "2024-12-04T08:16:44.4856069+00:00",
      "stopDateUtc": "2024-12-04T08:16:44.4856069+00:00",
      "careStatementDateUtc": "2024-12-04T08:16:44.4856069+00:00",
      "status": 1,
      "transmissionType": 1,
      "emailAddress": "sample string 9",
      "errorLog": "sample string 10",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:16:44.4856069+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:16:44 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:16:44.4856069+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:16:44 AM"
      }
    },
    {
      "careStatementID": 1,
      "careStatementBatchID": 2,
      "clientID": 3,
      "buid": 4,
      "groupID": 5,
      "contactID": 1,
      "startDateUtc": "2024-12-04T08:16:44.4856069+00:00",
      "stopDateUtc": "2024-12-04T08:16:44.4856069+00:00",
      "careStatementDateUtc": "2024-12-04T08:16:44.4856069+00:00",
      "status": 1,
      "transmissionType": 1,
      "emailAddress": "sample string 9",
      "errorLog": "sample string 10",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:16:44.4856069+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:16:44 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:16:44.4856069+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:16:44 AM"
      }
    }
  ],
  "buid": 5,
  "groupID": 6,
  "subGroupIDs": [
    1,
    2
  ],
  "triggeringUserID": 1,
  "triggeringWorkerID": 1,
  "recordState": 1,
  "errorLog": "sample string 7",
  "created": {
    "dateUtc": "2024-12-04T08:16:44.4856069+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:16:44 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:16:44.4856069+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:16:44 AM"
  }
}

application/xml, text/xml

Sample:
<CareStatementBatchDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AdmissionTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AdmissionTypes>
  <BUID>5</BUID>
  <CareStatementBatchID>1</CareStatementBatchID>
  <CareStatements>
    <CareStatementDTO>
      <BUID>4</BUID>
      <CareStatementBatchID>2</CareStatementBatchID>
      <CareStatementDateUtc>2024-12-04T08:16:44.4856069+00:00</CareStatementDateUtc>
      <CareStatementID>1</CareStatementID>
      <ClientID>3</ClientID>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T08:16:44.4856069+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <EmailAddress>sample string 9</EmailAddress>
      <ErrorLog>sample string 10</ErrorLog>
      <GroupID>5</GroupID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:16:44.4856069+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <StartDateUtc>2024-12-04T08:16:44.4856069+00:00</StartDateUtc>
      <Status>Pending</Status>
      <StopDateUtc>2024-12-04T08:16:44.4856069+00:00</StopDateUtc>
      <TransmissionType>Email</TransmissionType>
    </CareStatementDTO>
    <CareStatementDTO>
      <BUID>4</BUID>
      <CareStatementBatchID>2</CareStatementBatchID>
      <CareStatementDateUtc>2024-12-04T08:16:44.4856069+00:00</CareStatementDateUtc>
      <CareStatementID>1</CareStatementID>
      <ClientID>3</ClientID>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T08:16:44.4856069+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <EmailAddress>sample string 9</EmailAddress>
      <ErrorLog>sample string 10</ErrorLog>
      <GroupID>5</GroupID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:16:44.4856069+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <StartDateUtc>2024-12-04T08:16:44.4856069+00:00</StartDateUtc>
      <Status>Pending</Status>
      <StopDateUtc>2024-12-04T08:16:44.4856069+00:00</StopDateUtc>
      <TransmissionType>Email</TransmissionType>
    </CareStatementDTO>
  </CareStatements>
  <ClientIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ClientIDs>
  <Created>
    <DateUtc>2024-12-04T08:16:44.4856069+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <ErrorLog>sample string 7</ErrorLog>
  <FromDateUtc>2024-12-04T08:16:44.4856069+00:00</FromDateUtc>
  <GenerationDateUtc>2024-12-04T08:16:44.4856069+00:00</GenerationDateUtc>
  <GroupID>6</GroupID>
  <Label>sample string 2</Label>
  <LastUpdated>
    <DateUtc>2024-12-04T08:16:44.4856069+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <RecordState>Active</RecordState>
  <Status>Pending</Status>
  <SubGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubGroupIDs>
  <ToDateUtc>2024-12-04T08:16:44.4856069+00:00</ToDateUtc>
  <TriggeringUserID>1</TriggeringUserID>
  <TriggeringWorkerID>1</TriggeringWorkerID>
</CareStatementBatchDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:
��T�N�0���WR�4��UB���8��d	q��CU��8�I���8�����zvvv��ϯ%�³$�N��}<b��\�!g�B�98�`V���\�����
@a2U��bjbz�s?�x~�ޏ�0
���y8��<�(�P�v/�jW�
4��W��g.�̴&��E	5��x���O~݈E7.�WY¢��AU��Q�*��wD��v�h�ʖ�7նm�߮AQ�ik���a� h}����]z�!V���m|E�O2mɒV:+
�$$��h%����
��A׶p����lⵙ�����r/9�����f�4�i
-��~s���Ė�`)�$c�|Q���pv]�첝���ߙ5�

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/x-compressed-json

Sample:

Sample not available.