DELETE Api/Documents/{id}

Usuwa asynchronicznie obiekt Document z bazy danych

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

identyfikator obiektu

integer

Required

Body Parameters

None.

Response Information

Resource Description

DocumentDto
NameDescriptionTypeAdditional information
DocumentId

integer

None.

ProfileId

string

Required

AuthorId

string

None.

ApprovedBy

string

None.

TypeOfDocumentId

integer

Required

IsValid

boolean

None.

IsActive

boolean

None.

CreationDate

date

None.

DocumentNumber

string

None.

NumberOfDaysLimit

integer

None.

LastUpdate

date

None.

StartDate

date

Required

EndDate

date

None.

Comments

string

None.

Files

Collection of string

None.

FilesToUpload

Collection of IdentityDocDto

None.

DocumentStatusId

integer

None.

VersionOfDocumentId

integer

None.

OrganizationalUnitId

integer

None.

WorkPositionId

integer

None.

RecruitmentProjectId

integer

None.

IsPaid

boolean

None.

ProviderId

integer

None.

DkrSettings

string

None.

SigningDate

date

None.

ProfileName

string

None.

ProfileSurname

string

None.

ProfilePassportNumber

string

None.

AssignedTypeOfDocumentAttributes

Collection of AssignedTypeOfDocumentAttributeDto

None.

OrganizationalUnitName

string

None.

RecruitmentProjectName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "documentId": 1,
  "profileId": "sample string 2",
  "authorId": "sample string 3",
  "approvedBy": "sample string 4",
  "typeOfDocumentId": 5,
  "isValid": true,
  "isActive": true,
  "creationDate": "2024-05-18T04:04:36.6994395+00:00",
  "documentNumber": "sample string 9",
  "numberOfDaysLimit": 1,
  "lastUpdate": "2024-05-18T04:04:36.6994395+00:00",
  "startDate": "2024-05-18T04:04:36.6994395+00:00",
  "endDate": "2024-05-18T04:04:36.6994395+00:00",
  "comments": "sample string 11",
  "files": [
    "sample string 1",
    "sample string 2"
  ],
  "filesToUpload": [
    {
      "fileName": "sample string 1",
      "content": "sample string 2"
    },
    {
      "fileName": "sample string 1",
      "content": "sample string 2"
    }
  ],
  "documentStatusId": 1,
  "versionOfDocumentId": 1,
  "organizationalUnitId": 1,
  "workPositionId": 1,
  "recruitmentProjectId": 1,
  "isPaid": true,
  "providerId": 1,
  "dkrSettings": "sample string 13",
  "signingDate": "2024-05-18T04:04:36.6994395+00:00",
  "profileName": "sample string 14",
  "profileSurname": "sample string 15",
  "profilePassportNumber": "sample string 16",
  "assignedTypeOfDocumentAttributes": [
    {
      "assignedTypeOfDocumentAttributeId": 1,
      "typeOfDocumentAttributeId": 2,
      "documentId": 3,
      "value": "sample string 4"
    },
    {
      "assignedTypeOfDocumentAttributeId": 1,
      "typeOfDocumentAttributeId": 2,
      "documentId": 3,
      "value": "sample string 4"
    }
  ],
  "organizationalUnitName": "sample string 17",
  "recruitmentProjectName": "sample string 18"
}

multipart/form-data

Sample:
{"documentId":1,"profileId":"sample string 2","authorId":"sample string 3","approvedBy":"sample string 4","typeOfDocumentId":5,"isValid":true,"isActive":true,"creationDate":"2024-05-18T04:04:36.6994395+00:00","documentNumber":"sample string 9","numberOfDaysLimit":1,"lastUpdate":"2024-05-18T04:04:36.6994395+00:00","startDate":"2024-05-18T04:04:36.6994395+00:00","endDate":"2024-05-18T04:04:36.6994395+00:00","comments":"sample string 11","files":["sample string 1","sample string 2"],"filesToUpload":[{"fileName":"sample string 1","content":"sample string 2"},{"fileName":"sample string 1","content":"sample string 2"}],"documentStatusId":1,"versionOfDocumentId":1,"organizationalUnitId":1,"workPositionId":1,"recruitmentProjectId":1,"isPaid":true,"providerId":1,"dkrSettings":"sample string 13","signingDate":"2024-05-18T04:04:36.6994395+00:00","profileName":"sample string 14","profileSurname":"sample string 15","profilePassportNumber":"sample string 16","assignedTypeOfDocumentAttributes":[{"assignedTypeOfDocumentAttributeId":1,"typeOfDocumentAttributeId":2,"documentId":3,"value":"sample string 4"},{"assignedTypeOfDocumentAttributeId":1,"typeOfDocumentAttributeId":2,"documentId":3,"value":"sample string 4"}],"organizationalUnitName":"sample string 17","recruitmentProjectName":"sample string 18"}

application/xml, text/xml

Sample:
<DocumentDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocumentId>1</DocumentId>
  <ProfileId>sample string 2</ProfileId>
  <AuthorId>sample string 3</AuthorId>
  <ApprovedBy>sample string 4</ApprovedBy>
  <TypeOfDocumentId>5</TypeOfDocumentId>
  <IsValid>true</IsValid>
  <IsActive>true</IsActive>
  <CreationDate />
  <DocumentNumber>sample string 9</DocumentNumber>
  <NumberOfDaysLimit>1</NumberOfDaysLimit>
  <LastUpdate />
  <StartDate />
  <EndDate />
  <Comments>sample string 11</Comments>
  <Files>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Files>
  <FilesToUpload>
    <IdentityDocDto>
      <FileName>sample string 1</FileName>
      <Content>sample string 2</Content>
    </IdentityDocDto>
    <IdentityDocDto>
      <FileName>sample string 1</FileName>
      <Content>sample string 2</Content>
    </IdentityDocDto>
  </FilesToUpload>
  <DocumentStatusId>1</DocumentStatusId>
  <VersionOfDocumentId>1</VersionOfDocumentId>
  <OrganizationalUnitId>1</OrganizationalUnitId>
  <WorkPositionId>1</WorkPositionId>
  <RecruitmentProjectId>1</RecruitmentProjectId>
  <IsPaid>true</IsPaid>
  <ProviderId>1</ProviderId>
  <DkrSettings>sample string 13</DkrSettings>
  <SigningDate />
  <ProfileName>sample string 14</ProfileName>
  <ProfileSurname>sample string 15</ProfileSurname>
  <ProfilePassportNumber>sample string 16</ProfilePassportNumber>
  <AssignedTypeOfDocumentAttributes>
    <AssignedTypeOfDocumentAttributeDto>
      <AssignedTypeOfDocumentAttributeId>1</AssignedTypeOfDocumentAttributeId>
      <TypeOfDocumentAttributeId>2</TypeOfDocumentAttributeId>
      <DocumentId>3</DocumentId>
      <Value>sample string 4</Value>
    </AssignedTypeOfDocumentAttributeDto>
    <AssignedTypeOfDocumentAttributeDto>
      <AssignedTypeOfDocumentAttributeId>1</AssignedTypeOfDocumentAttributeId>
      <TypeOfDocumentAttributeId>2</TypeOfDocumentAttributeId>
      <DocumentId>3</DocumentId>
      <Value>sample string 4</Value>
    </AssignedTypeOfDocumentAttributeDto>
  </AssignedTypeOfDocumentAttributes>
  <OrganizationalUnitName>sample string 17</OrganizationalUnitName>
  <RecruitmentProjectName>sample string 18</RecruitmentProjectName>
</DocumentDto>