POST api/Processes/CreateDispatch

CREATE dispatch process

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DistributionType	string	None.
Deadline	date	None.
UserEmail	string	None.
DispatchFolder	DispatchFolder	None.
Folio	string	None.
Priority	integer	None.
CountryCode	string	None.
WorkflowId	string	None.
UsersSelected	Collection of DistributionUserSelected	None.
AttachmentList	AttachmentOnProcessList	None.

Request Formats

application/json, text/json

Sample:

{
  "DistributionType": "sample string 1",
  "Deadline": "2025-04-04T01:18:48.2708258+01:00",
  "UserEmail": "sample string 2",
  "DispatchFolder": {
    "Nad": 1,
    "DispatchNumber": "sample string 2",
    "FolderID": 1,
    "Subject": "sample string 3",
    "SubjectTypes": [
      1,
      2
    ],
    "Message": "sample string 4",
    "Nature": "sample string 5",
    "Interveners": "sample string 6",
    "NumberPDPP": "sample string 7",
    "K2ProcessInstanceID": "sample string 8",
    "SourceSecFsID": 1,
    "SourceType": "sample string 9",
    "SourceID": 1,
    "DeadlineType": "sample string 10",
    "DispatchDate": "sample string 11",
    "ParentFolderID": 12
  },
  "Folio": "sample string 3",
  "Priority": 4,
  "CountryCode": "sample string 5",
  "WorkflowId": "sample string 6",
  "UsersSelected": [
    {
      "UserEmail": "sample string 1",
      "UserType": "sample string 2"
    },
    {
      "UserEmail": "sample string 1",
      "UserType": "sample string 2"
    }
  ],
  "AttachmentList": {
    "DraftIds": "sample string 1",
    "ProcessInstanceID": "sample string 2",
    "Attachments": [
      {
        "SourceId": "sample string 1",
        "ApplicationId": 2
      },
      {
        "SourceId": "sample string 1",
        "ApplicationId": 2
      }
    ]
  }
}

application/xml, text/xml

Sample:

<DispatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GabineteDigital.Services.Models">
  <AttachmentList>
    <Attachments>
      <AttachmentsModel.AttachmentOnProcessItem>
        <ApplicationId>2</ApplicationId>
        <SourceId>sample string 1</SourceId>
      </AttachmentsModel.AttachmentOnProcessItem>
      <AttachmentsModel.AttachmentOnProcessItem>
        <ApplicationId>2</ApplicationId>
        <SourceId>sample string 1</SourceId>
      </AttachmentsModel.AttachmentOnProcessItem>
    </Attachments>
    <DraftIds>sample string 1</DraftIds>
    <ProcessInstanceID>sample string 2</ProcessInstanceID>
  </AttachmentList>
  <CountryCode>sample string 5</CountryCode>
  <Deadline>2025-04-04T01:18:48.2708258+01:00</Deadline>
  <DispatchFolder>
    <DeadlineType>sample string 10</DeadlineType>
    <DispatchDate>sample string 11</DispatchDate>
    <DispatchNumber>sample string 2</DispatchNumber>
    <FolderID>1</FolderID>
    <Interveners>sample string 6</Interveners>
    <K2ProcessInstanceID>sample string 8</K2ProcessInstanceID>
    <Message>sample string 4</Message>
    <Nad>1</Nad>
    <Nature>sample string 5</Nature>
    <NumberPDPP>sample string 7</NumberPDPP>
    <ParentFolderID>12</ParentFolderID>
    <SourceID>1</SourceID>
    <SourceSecFsID>1</SourceSecFsID>
    <SourceType>sample string 9</SourceType>
    <Subject>sample string 3</Subject>
    <SubjectTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SubjectTypes>
  </DispatchFolder>
  <DistributionType>sample string 1</DistributionType>
  <Folio>sample string 3</Folio>
  <Priority>4</Priority>
  <UserEmail>sample string 2</UserEmail>
  <UsersSelected>
    <DistributionUserSelected>
      <UserEmail>sample string 1</UserEmail>
      <UserType>sample string 2</UserType>
    </DistributionUserSelected>
    <DistributionUserSelected>
      <UserEmail>sample string 1</UserEmail>
      <UserType>sample string 2</UserType>
    </DistributionUserSelected>
  </UsersSelected>
  <WorkflowId>sample string 6</WorkflowId>
</DispatchModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>