Хайлт

Баримт бичиг болон сервисээс хайна

Холбогдох заавар

1. Access token авах

1.1. Access token шинээр авах

Өөрийн системын нэвтрэх нэр, нууц үгээ оруулна.

  • accessToken - Дуусах хугацаа 1 хоног
  • refreshToken - Дуусах хугацаа 7 хоног

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/auth/signin

Request Body

json
{
  "username": "String", // Системийн хэрэглэгчийн нэвтрэх нэр
  "password": "String" // Системийн хэрэглэгчийн нууц үг
}

Response 201

json
{
  "accessToken": "String - accessToken", // docx системийн бүхий л API дуудах ашиглана. 1 хоног хүчинтэй
  "refreshToken": "String - refreshToken" // accessToken шинэчилж авахад ашиглагдана. 7 хоногт 1 удаа хүчинтэй.
}

Response 400

json
{
  "statusCode": 400,
  "message": "Нэвтрэх нэр эсвэл нууц үг буруу байна.",
  "error": "Bad Request"
}

1.2. Access token шинэчлэх

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/auth/refresh

Response 200

json
{
  "accessToken": "String", // docx системийн бүхий л API дуудах ашиглана. 1 хоног хүчинтэй
  "refreshToken": "String" // accessToken шинэчилж авахад ашиглагдана. 7 хоногт 1 удаа хүчинтэй.
}

Response 403

json
{
  "statusCode": 403,
  "message": "Access Denied.",
  "error": "Forbidden"
}

2. Байгууллага холбох

2.7. Байгууллагын Docx token холбох

Энэхүү Docx token-г өөрийн хөгжүүлж байгаа систем дээр "DOCX токен холбох" гэсэн цэс үүсгэн албан хаагчаар бүртгүүлэх форм хөгжүүлэх юм.

  • docxOrgToken - Байгууллагын DOCX токен.
  • orgInternalId - Байгууллагын систем дэх дотоод ID
  • orgInternalCode - Байгууллагын регистрийн дугаар
  • orgInternalName - Токен бүртгүүлж байгаа байгууллагын нэр
  • empPosName -албан тушаалын нэр
  • empLastName - ажилтны эцэг/эхийн нэр
  • empFirstName - ажилтны нэр

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/org/register/token

Request Body

json
{
  "docxOrgToken": "String", // docxOrgToken цаашид бичиг илгээхэд ашиглана.
  "orgInternalId": "String - [Length(100)]", // Ашиглах системийн Байгууллагын pk id
  "orgInternalCode": "String - [Length(20)]", // Ашиглах системийн Байгууллагын регистрийн дугаар
  "orgInternalName": "String - [Length(1000)]", // Ашиглах системийн Байгууллагын нэр
  "empPosName": "String - [Length(1000)]", // Ашиглах системийн нэвтэрсэн албан хаагчийин албан тушаалын нэр
  "empLastName": "String - [Length(1000)]", // Ашиглах системийн нэвтэрсэн албан хаагчийин эцэг/эх/-ийн нэр
  "empFirstName": "String - [Length(1000)]" // Ашиглах системийн нэвтэрсэн албан хаагчийин нэр
}

Response 201

json
{
  "id": "Number", // Docx байгууллагын PK ID
  "code": "String - [Length(20)]", // Docx байгууллагын регистрийн дугаар
  "name": "String - [Length(100)]", // Docx байгууллагын нэр
  "orgInternalId": "String - [Length(100)]", // Ашиглах систем дэх байгууллагын ID
  "orgInternalCode": "String - [Length(20)]", // Ашиглах систем дэх байгууллагын регистрийн дугаар
  "orgInternalName": "String - [Length(1000)]", //Ашиглах систем дэх байгууллагын нэр
  "programId": "Number", // Docx дэх байгууллагын ашиглаж байгаа системийн PK ID
  "programName": "String - [Length(100)]" // Docx дэх байгууллагын ашиглаж байгаа системийн нэр
}

2.4. Байгууллагын Docx token салгах

Method: DELETE

Endpoint:

http
DELETE https://docx.gov.mn/rest/api/org/remove/token

Request Body

json
{
  "docxOrgToken": "String", // docxOrgToken цаашид бичиг илгээхэд ашиглана.
  "orgInternalId": "String - [Length(100)]", // Ашиглах системийн Байгууллагын pk id
  "orgInternalCode": "String - [Length(20)]", // Ашиглах системийн Байгууллагын регистрийн дугаар
  "orgInternalName": "String - [Length(1000)]", // Ашиглах системийн Байгууллагын нэр
  "empPosName": "String - [Length(1000)]", // Ашиглах системийн нэвтэрсэн албан хаагчийин албан тушаалын нэр
  "empLastName": "String - [Length(1000)]", // Ашиглах системийн нэвтэрсэн албан хаагчийин эцэг/эх/-ийн нэр
  "empFirstName": "String - [Length(1000)]" // Ашиглах системийн нэвтэрсэн албан хаагчийин нэр
}

Response 200

json
{
  "success": true
}

2.6. Шинээр бүртгэгдсэн байгууллага

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/org/new/:offset/:limit

Response 200

json
[
  {
    "id": "Number", //Docx байгууллагын PK ID
    "code": "String", // Docx байгууллагын регистрийн дугаар
    "name": "String", // Docx байгууллагын нэр,
    "nonCode": "Boolean", // Регистрийн дугааргүй байгууллага эсэх
    "parent": {
      "id": "Number", // Дээд байгууллагын pk id
      "name": "String", // Дээд байгууллагын нэр
      "code": "String" // Дээд байгууллагын РД
    }, // Регистрийн дугаартай дээд байгууллага - nullable
    "isActive": "Boolean", // Идэвхитэй байгууллага эсэх
    "program": {
      "id": "Number", // Ашиглаж байгаа системийн pk id
      "name": "String" // Ашиглаж байгаа системийн нэр
    }
  }
]

2.1. Байгууллагуудыг өөрийн системд хүлээн авах

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/org/receive

Request Body

json
{
  "orgId": "Number", // Docx системийн байгууллагын pk id
  "orgInternalId": "String - [Length(100)]", // Бүртгэл хүлээн авч байгаа системийн Байгууллагын pk id
  "orgInternalCode": "String - [Length(20)]", // Бүртгэл хүлээн авч байгаа системийн Байгууллагын регистрийн дугаар
  "orgInternalName": "String - [Length(1000)]" // Бүртгэл хүлээн авч байгаа системийн Байгууллагын нэр
}

Response 201

json
{
  "id": "Number", // Docx системийн байгууллагын pk id
  "code": "String - [Length(20)]", // docx системийн байгууллагын регистрийн дугаар
  "name": "String - [Length(1000]", // docx системийн байгууллагын нэр
  "program": {
    "id": "Number", // Docx систем дэх байгууллагын ашиглаж байгаа системын pk id
    "name": "String" // Docx систем дэх байгууллагын ашиглаж байгаа системын нэр
  }
}

2.2. Холбосон байгууллагууд

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/org/registered/:offset/:limit

Response 200

json
[
  {
    "id": "Number", // docx байгууллагын PK ID
    "code": "String - [Length(20)]", // docx байгууллагын регистрийн дугаар
    "name": "String - [Length(1000)]", // docx байгууллагын нэр
    "token": "String", // docxOrgToken
    "nonCode": "Boolean", // Регистрийн дугааргүй байгууллага эсэх
    "parent": {
      "id": "Number", // Дээд байгууллагын pk id
      "name": "String", // Дээд байгууллагын нэр
      "code": "String" // Дээд байгууллагын РД
    }, // Регистрийн дугаартай дээд байгууллага - nullable
    "program": {
      "id": "Number", // docx дэх байгууллагын ашиглаж байгаа системын ID
      "name": "String - [Length(100)]" // docx дэх байгууллагын ашиглаж байгаа системын нэр
    }
  }
]

2.5. Бүртгэгдсэн байгууллагууд

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/org/received/:offset/:limit

Response 200

json
[
  {
    "id": "Number", // docx байгууллагын PK ID
    "code": "String - [Length(20)]", // docx байгууллагын регистрийн дугаар
    "name": "String - [Length(1000)]", // docx байгууллагын нэр
    "nonCode": "Boolean", // Регистрийн дугааргүй байгууллага эсэх
    "parent": {
      "id": "Number", // Дээд байгууллагын pk id
      "name": "String", // Дээд байгууллагын нэр
      "code": "String" // Дээд байгууллагын РД
    }, // Регистрийн дугаартай дээд байгууллага - nullable
    "program": {
      "id": "Number", // docx дэх байгууллагын ашиглаж байгаа системын ID
      "name": "String - [Length(100)]" // docx дэх байгууллагын ашиглаж байгаа системын нэр
    }
  }
]

2.3. Байгууллага хайх

Байгууллагын нэрээр хайж Docx системийн байгууллагын id олох

ТалбарТөрөлТайлбар
namestringБайгууллагын нэр

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/org/list?name=String&code=String&id=Number

Response 200

json
[
  {
    "matchpercent": "Number", // Нэр таарсан хувь
    "name": "String", // docx байгууллагын нэр
    "id": "Number", // docx байгууллагын ID
    "code": "String", // docx байгууллагын регистрийн дугаар
    "nonCode": false, // Регистргүй байгууллага эсэх
    "parentId": null, // Дээд байгууллагын pk id
    "parentCode": null, // Дээд байгууллагын РД
    "parentName": null, // Дээд байгууллагын нэр
    "programId": "Number", // Ашиглаж байгаа системын ID
    "programName": "String", // Ашиглаж байгаа системын нэр
    "orgInternalId": "String", // Танай системийн байгууллагын ID
    "orgInternalCode": "String", // Танай системийн байгууллагын регистрийн дугаар
    "orgInternalName": "String" // Танай системийн байгууллагын нэр
  }
]

3. Бичиг

3.1. Бичиг илгээх / form-data

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/document/multer

Response 201

json
{
  "createdDate": "Datetime", // үүсгэсэн огноо
  "documentDate": "Date", //Албан бичгийн огноо
  "documentName": "String", //Албан бичгийн тэргүү
  "documentNumber": "Number", //Албан бичгийн дугаар
  "id": "Number", //Docx системд бүртгэгдсэн ID
  "isActive": "Boolean", //Docx системд бүртгэгдсэн ID
  "isNeedReply": "Boolean", //Хариутай эсэх
  "isReplyDoc": "Boolean", //албан бичгийн хариу эсэх
  "noOfPages": "Number, Double", //Хуудасны тоо
  "orgId": "Number", // Илгээсэн байгууллагын docxOrgId
  "programId": "Number", //Нэмсэн програмын id
  "priorityId": "Number", // Чухал эсэх? 1-5
  "responseDate": "Date", // Хариу огноо
  "responseTypeId": "Number", // Хариуны төрөл 1, 2
  "signName": "String", //Гарын үсэг зурсан алба хаагчийн нэр
  "srcDocumentCode": "String", // Эх бичгийн дугаар
  "statusId": "Number", // Бичгийн төлвийн ID
  "fileList": [
    {
      "id": "Number", //Docx системд үүссэн Id
      "createdDate": "Datetime", //Docx системд үүссэн огноо
      "docId": "Number", //Docx системд үүссэн бичгийн id
      "name": "String", //Файлын нэр
      "size": "Number", //Файлын хэмжээ
      "type": "String", //Файлын төрөл - application/pdf
      "url": "String", // Файлын татах холбоос
      "orgList": {
        "id": "Number", // АЙДИ
        "orgId": "Number", // Хүлээн авах байгууллагын ID
        "fileId": "Number", // Илгээсэн файлын ID
        "createdDate": "Datetime" // Нэмсэн огноо
      }
    }
  ],
  "fileCount": "Number", //Файлын тоо
  "orgName": "String", //Албан бичиг явуулсан байгууллагын нэр
  "orgCode": "String", //Албан бичиг явуулсан байгууллагын регистер
  "orgList": {
    "id": "Number", //DOCX системд бүртгэгдсэн хүлээн авах бичгийн ID
    "docId": "Number", //DOCX системд бүртгэгдсэн бичгийн ID
    "orgId": "Number", //DOCX системд бүртгэгдсэн байгууллагын ID
    "programId": "Number", //DOCX системд бүртгэгдсэн програмын ID
    "statusId": "Number", //DOCX системд бүртгэгдсэн төлөв ID
    "createdDate": "Datetime", //Үүсгэсэн огноо
    "statusPerson": "String", //Статус өөрчилсөн албан хаагчийн нэр
    "statusPosition": "String", //Статус өөрчилсөн албан хаагчийн албан тушаалын нэр
    "statusComment": "String", //Статус өөрчилсөн тайлбар
    "isDownload": "Boolean" // Таталт хийсэн эсэх
  }
}

3.2. Бичиг илгээх / raw

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/document

Request Body

json
{
  "docxOrgToken": "String", // Илгээж байгаа байгууллагын docxOrgToken
  "documentDate": "Date", // Бичгийн огноо [YYYY-MM-DD]
  "documentTypeId": "Number", // Бичгийн төрөл 1-бичиг, 2-өргөдөл
  "documentNumber": "String", // Бичгийн дугаар
  "documentName": "String", // Бичгийн агуулга
  "signName": "String", // Хэнээс
  "orgList": [
    {
      "orgId": "Number" // Хүлээн авах байгууллагуудын Docx id
    }
  ],
  "fileList": [
    {
      "name": "String", // Файлын нэр
      "size": "Number", // Файлын хэмжээ
      "type": "String", // Файлын төрөл - content type
      "data": "Buffer Base64" // Файлын дата
    }
  ],
  "isReplyDoc": "Boolean", // Бичгийн хариу эсэх
  "isNeedReply": "Boolean", // Хариу шаардах эсэх
  "priorityId": "Number", // Ач холбогдол [1, 2, 3, 4, 5]
  "noOfPages": "Number", // Файлын хуудсын тоо
  "responseTypeId": "Number", // Хариуны төрөл [1, 2]
  "responseDate": "Date" // Хариуны огноо [YYYY-MM-DD]
}

Response 200

json
{
  "createdDate": "Datetime", // үүсгэсэн огноо
  "documentDate": "Date", //Албан бичгийн огноо
  "documentName": "String", //Албан бичгийн тэргүү
  "documentNumber": "Number", //Албан бичгийн дугаар
  "id": "Number", //Docx системд бүртгэгдсэн ID
  "isActive": "Boolean", //Docx системд бүртгэгдсэн ID
  "isNeedReply": "Boolean", //Хариутай эсэх
  "isReplyDoc": "Boolean", //албан бичгийн хариу эсэх
  "noOfPages": "Number, Double", //Хуудасны тоо
  "orgId": "Number", // Илгээсэн байгууллагын docxOrgId
  "programId": "Number", //Нэмсэн програмын id
  "priorityId": "Number", // Чухал эсэх? 1-5
  "responseDate": "Date", // Хариу огноо
  "responseTypeId": "Number", // Хариуны төрөл 1, 2
  "signName": "String", //Гарын үсэг зурсан алба хаагчийн нэр
  "srcDocumentCode": "String", // Эх бичгийн дугаар
  "statusId": "Number", // Бичгийн төлвийн ID
  "fileList": [
    {
      "id": "Number", //Docx системд үүссэн Id
      "createdDate": "Datetime", //Docx системд үүссэн огноо
      "docId": "Number", //Docx системд үүссэн бичгийн id
      "name": "String", //Файлын нэр
      "size": "Number", //Файлын хэмжээ
      "type": "String", //Файлын төрөл - application/pdf
      "url": "String", // Файлын татах холбоос
      "orgList": {
        "id": "Number", // АЙДИ
        "orgId": "Number", // Хүлээн авах байгууллагын ID
        "fileId": "Number", // Илгээсэн файлын ID
        "createdDate": "Datetime" // Нэмсэн огноо
      }
    }
  ],
  "fileCount": "Number", //Файлын тоо
  "orgName": "String", //Албан бичиг явуулсан байгууллагын нэр
  "orgCode": "String", //Албан бичиг явуулсан байгууллагын регистер
  "orgList": {
    "id": "Number", //DOCX системд бүртгэгдсэн хүлээн авах бичгийн ID
    "docId": "Number", //DOCX системд бүртгэгдсэн бичгийн ID
    "orgId": "Number", //DOCX системд бүртгэгдсэн байгууллагын ID
    "programId": "Number", //DOCX системд бүртгэгдсэн програмын ID
    "statusId": "Number", //DOCX системд бүртгэгдсэн төлөв ID
    "createdDate": "Datetime", //Үүсгэсэн огноо
    "statusPerson": "String", //Статус өөрчилсөн албан хаагчийн нэр
    "statusPosition": "String", //Статус өөрчилсөн албан хаагчийн албан тушаалын нэр
    "statusComment": "String", //Статус өөрчилсөн тайлбар
    "isDownload": "Boolean" // Таталт хийсэн эсэх
  }
}

3.3. Илгээсэн бичиг устгах

Method: DELETE

Endpoint:

http
DELETE https://docx.gov.mn/rest/api/document

Request Body

json
{
  "docxOrgToken": "",
  "id": 7937
}

Response 200

json
{
  "error": "deleted",
  "message": "Бичиг устгагдсан байна.",
  "statusCode": 403
}

3.4. Шинээр ирсэн бичгүүд татах

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/document/new/:offset/:limit

Response 200

json
{
  "createdDate": "Datetime", // үүсгэсэн огноо
  "documentDate": "Date", //Албан бичгийн огноо
  "documentName": "String", //Албан бичгийн тэргүү
  "documentNumber": "Number", //Албан бичгийн дугаар
  "id": "Number", //Docx системд бүртгэгдсэн ID
  "isActive": "Boolean", //Docx системд бүртгэгдсэн ID
  "isNeedReply": "Boolean", //Хариутай эсэх
  "isReplyDoc": "Boolean", //албан бичгийн хариу эсэх
  "noOfPages": "Number, Double", //Хуудасны тоо
  "orgId": "Number", // Илгээсэн байгууллагын docxOrgId
  "programId": "Number", //Нэмсэн програмын id
  "priorityId": "Number", // Чухал эсэх? 1-5
  "responseDate": "Date", // Хариу огноо
  "responseTypeId": "Number", // Хариуны төрөл 1, 2
  "signName": "String", //Гарын үсэг зурсан алба хаагчийн нэр
  "srcDocumentCode": "String", // Эх бичгийн дугаар
  "statusId": "Number", // Бичгийн төлвийн ID
  "fileList": [
    {
      "id": "Number", //Docx системд үүссэн Id
      "createdDate": "Datetime", //Docx системд үүссэн огноо
      "docId": "Number", //Docx системд үүссэн бичгийн id
      "name": "String", //Файлын нэр
      "size": "Number", //Файлын хэмжээ
      "type": "String", //Файлын төрөл - application/pdf
      "url": "String", // Файлын татах холбоос
      "orgList": {
        "id": "Number", // АЙДИ
        "orgId": "Number", // Хүлээн авах байгууллагын ID
        "fileId": "Number", // Илгээсэн файлын ID
        "createdDate": "Datetime" // Нэмсэн огноо
      }
    }
  ],
  "fileCount": "Number", //Файлын тоо
  "orgName": "String", //Албан бичиг явуулсан байгууллагын нэр
  "orgCode": "String", //Албан бичиг явуулсан байгууллагын регистер
  "orgList": {
    "id": "Number", //DOCX системд бүртгэгдсэн хүлээн авах бичгийн ID
    "docId": "Number", //DOCX системд бүртгэгдсэн бичгийн ID
    "orgId": "Number", //DOCX системд бүртгэгдсэн байгууллагын ID
    "programId": "Number", //DOCX системд бүртгэгдсэн програмын ID
    "statusId": "Number", //DOCX системд бүртгэгдсэн төлөв ID
    "createdDate": "Datetime", //Үүсгэсэн огноо
    "statusPerson": "String", //Статус өөрчилсөн албан хаагчийн нэр
    "statusPosition": "String", //Статус өөрчилсөн албан хаагчийн албан тушаалын нэр
    "statusComment": "String", //Статус өөрчилсөн тайлбар
    "isDownload": "Boolean" // Таталт хийсэн эсэх
  }
}

3.5. Файл дуудах

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/file/download/view/:fileId

Response

json
PDF файл харагдана.

3.6. Нэг бичгийн мэдээлэл татах

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/document/:id

Response

json
{
  "createdDate": "2023-01-19T06:02:00.073Z", //Docx дээр үүссэн огноо
  "createdUserId": null, //Docx дээр үүссэн хэрэглэгч
  "documentDate": "2022-12-26", //Албан бичгийн дугаар
  "documentName": "Shine bichig ilgeedh", //Албан бичгийн тэргүү
  "documentNumber": "03", //Албан бичгийн дугаар
  "documentTypeId": 1,
  "id": "7944", //Docx дээр бүртгэгдсэн ID
  "isActive": true,
  "isNeedReply": false, //Хариутай эсэх
  "isReplyDoc": false, //Хариу албан бичгийн дугаар
  "noOfPages": 1, //Хуудасны тоо
  "orgId": "5482", //Илгээсэн байгууллагын DOCX-д бүртгэгдсэн ID
  "orgName": "Цахим хөгжил, харилцаа холбооны яам", //Илгээсэн байгууллагын нэр
  "orgCode": "6806252", //Илгээсэн байгууллагын регистрийн дугаар
  "programId": null, //Илгээсэн байгууллагын албан хэрэг хөтлөлтйин системийн DOCX-д бүртгэгдсэн ID
  "priorityId": 1,
  "responseDate": "2022-12-26", // илгээсэн огноо
  "responseTypeId": 1,
  "signName": "test", // Гарын үсэг зурсан ажилтны нэр
  "srcDocumentCode": null,
  "fileList": [
    {
      "id": "9030", //DOCX бүртгэгдсэн файлын ID
      "createdDate": "2023-01-18T22:01:59.885Z", //Үүсгэсэн огноо
      "createdUserId": "1", //Үүсгэсэн ажилтын id
      "docId": "7944", //DOCX бүртгэгдсэн албан бичгийн ID
      "name": "638b1f06f6207b204a013eee.pdf", //Файлын нэр
      "size": "122953", //Файлын хэмжээ
      "type": "application/pdf", //Файлын төрөл
      "url": "/api/file/download/view/7944/h_S1uS4tMR-by_OwXyX2JIUrI_X_Qg1rXzMbLOVydILQWXLLY-UOh0bjNRM7aplkTl7Pp2EqzIE4Yum51ixLan_eoIJ0-jt-UcjUSLU-JgPEn8KWRIhuezc3-XvT9KSOYMnmn1qnEiAXs6Fx9-ls8g-Tu-bluJV1XvAYKjLOrkY", //Файлын зам
      "orgList": {
        "id": "4490",
        "orgId": "2", //DOCX бүртгэгдсэн байгууллагын ID
        "fileId": "9030", //DOCX бүртгэгдсэн файлын ID
        "updatedDate": null, //Зассан огноо
        "createdDate": "2023-01-19" //Үүсгэсэн огноо
      }
    }
  ],
  "fileCount": 1, //Нийт файлын тоо
  "statusId": 1, //Бичгийн төлөвийн Id
  "statusCode": "NEW", //Бичгийн төлөвийн код
  "statusName": "Шинэ", //Бичгийн төлөвийн нэр
  "orgList": {
    "id": "8981",
    "docId": "7944", //DOCX бүртгэгдсэн албан бичгийн ID
    "orgId": "2", //DOCX бүртгэгдсэн байгууллагын ID
    "programId": "16", //DOCX бүртгэгдсэн системийн ID
    "statusId": 1, //Бичгийн төлөв
    "createdDate": "2023-01-19T06:02:00.094Z", //Үүсгэсэн огноо
    "updatedDate": null, //Зассан огноо
    "statusPerson": null, //Төлөв өөрчилсөн ажилтан нэр
    "statusPosition": null, //Төлөв өөрчилсөн албан тушаалын нэр
    "statusComment": null, //Төлөв өөрчилсөн тайлбар
    "isDownload": false // Бичгийг татсан эсэх
  }
}

4. Бичгийн төлөв өөрчлөх

4.1. Бичгийн төлөв

  • Шинэ: 1
  • Үзсэн: 2
  • Дэлгэрэнгүй үзсэн: 3
  • Файл татаж авсан: 4
  • Буцаасан: 5
  • Хүлээн авсан: 6
  • Шийдвэрлэсэн: 9

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/document/ref/status

Response 200

json
[
  {
    "id": "1",
    "name": "Шинэ",
    "code": "NEW"
  },
  {
    "id": "2",
    "name": "Үзсэн",
    "code": "SEEN"
  },
  {
    "id": "3",
    "name": "Дэлгэрэнгүй үзсэн",
    "code": "SEEN_DETAIL"
  },
  {
    "id": "4",
    "name": "Файл татаж авсан",
    "code": "DOWNLOADED"
  },
  {
    "id": "5",
    "name": "Буцаасан",
    "code": "CANCELLED"
  },
  {
    "id": "6",
    "name": "Хүлээн авсан",
    "code": "RECEIVED"
  },
  {
    "id": "9",
    "name": "Шийдвэрлэсэн",
    "code": "DECIDED"
  }
]

4.2. Бичгийн төлөв өөрчлөх

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/document/status

Request Body

json
{
  "docxOrgToken": "String", // Төлөв өөрчилж байгаа байгууллагын токен
  "id": "Number", // Бичгийн pk ID
  "statusId": "Number", // Өөрчилж байгаа төлвийн pk ID
  "statusComment": "String", // Тайлбар
  "statusPerson": "String", // Өөрчилсөн албан хаагчийн нэр
  "statusPosition": "String" // Өөрчилсөн албан хаагчийн албан тушаал
}

Response

json
{
  "success": true
}

4.3. Шинээр ирсэн бичгийн төлвүүд хүлээн авах

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/document/status/new/:offset/:limit

Response 200

json
[
  {
    "id": "Number", // Бичгийн төлвийн Pk id
    "docId": "Number", // Бичгийн Pk id
    "orgId": "Number", // Төлөв өөрчилсөн байгууллагын Pk id
    "statusId": "Number", // Төлвийн  Pk id
    "createdDate": "Datetime", // Бүртгэгдсэн огноо
    "updatedDate": "Datetime", // Төлөв өөрчлөгдсөн огноо
    "statusPerson": "String", // Төлөв өөрчилсөн албан хаагчын нэр
    "statusPosition": "String", // Төлөв өөрчилсөн албан хаагчын албан тушаал
    "statusComment": "String", // Тайлбар
    "doc": {
      "documentNumber": "String", // Илгээсэн бичгийн дугаар
      "documentDate": "Date - String", // Илгээсэн бичгийн огноо
      "orgId": "Number" // Илгээсэн байгууллагын docxOrgId
    }
  }
]

4.4. Бичгийн төлөв татсан тэмдлэгээ хийх

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/document/status/download

Request Body

json
{
  "ids": ["Number", "Number", "Number"] // Хүлээн авсан төлвүүдийн pk id
}

Response 201

json
{
  "success": true
}

5. Байгууллагын өөрчлөлт

5.1. Системгүй болсон байгууллагууд

Байгууллагын албан хаагч эсвэл систем токен салгасны дараа бусад системүүдын энэ жагсаалтад орно.

Method: GET

Endpoint:

http
GET {{LOCAL_URL}}/org/removed/:offset/:limit

Response 200

json
[
  {
    "id": "Number", // Docx Байгууллагын pk id
    "code": "String", // Байгууллагын код
    "name": "String", // Байгууллагын нэр
    "nonCode": "Boolean", // Регистрийн дугааргүй байгууллага эсэх
    "parent": {
      "id": "Number", // Дээд байгууллагын pk id
      "name": "String", // Дээд байгууллагын нэр
      "code": "String" // Дээд байгууллагын РД
    },
    "isActive": "Boolean", // Идэвхтэй байгууллага эсэх
    "program": {
      "id": null,
      "name": null
    }
  }
]

5.3. Системгүй болсонг хүлээн авах

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/org/removed/receive

Request Body

json
{
  "ids": ["Number", "Number"] // docx байгууллагын pk id
}

Response 201

json
{
  "success": true
}

5.4. Мэдээлэл өөрчлөгдсөн байгууллагууд

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/org/updated/:offset/:limit

Response 200

json
[
  {
    "id": "Number", // Docx Байгууллагын pk id
    "code": "String", // Байгууллагын код
    "name": "String", // Байгууллагын нэр
    "isActive": "Boolean", // Идэвхтэй байгууллага эсэх
    "program": {
      "id": "Number", // ашиглаж байгаа Docx системийн pk id
      "name": "String" // ашиглаж байгаа Docx системийн нэр
    }
  }
]

5.2. Мэдээлэл өөрчлөгдсөнг хүлээн авах

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/org/updated/receive

Request Body

json
{
  "ids": ["Number", "Number"] // docx байгууллагын pk id
}

Response 201

json
{
  "success": true
}

6. API -гаар гэрээ байгуулах

6.1. Байгууллагын гэрээ бүртгүүлэх

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/org/contract/register

Request Body

json
{
  "orgInternalName": "String", // Байгууллагын нэр
  "orgInternalCode": "String", // Байгууллагын регистрийн дугаар
  "orgInternalId": "String", // Ашиглах системийн дотоод АЙДИ
  "parentCode": "String", // Регистргүй байгууллагын хувь дээд байгууллагын РД
  "shortName": "String - Optional", // байгууллагын товч нэр
  "address": "String", // байгууллагын одоогийн хаяг
  "phone": "String - [IsNumber, Length(8)]", // байгууллагын холбоо барих утас
  "email": "String - [IsEmail]", // байгууллагын холбоо барих цахим шуудангийн хаяг
  "positionName": "String", // Гэрээ хийх албан хаагчийн албан тушаал
  "lastName": "String - [IsCyrillic]", // Гэрээ хийх албан хаагчийн эцэг/эх/-ийн нэр
  "firstName": "String - [IsCyrillic]" // Гэрээ хийх албан хаагчийн нэр
}

Response 201

json
{
  "id": "Number", // Docx байгууллагын АЙДИ
  "code": "String [IsNumber]", // Регистрийн дугаар
  "name": "String", // Байгууллагын нэр
  "shortName": "String [Optional]", // Байгууллагын товч нэр
  "programId": "Number", // Ашиглагладаг системийн АЙДИ
  "programName": "String", // Ашиглагладаг системийн нэр
  "orgInternalId": "String", // Ашиглагладаг системийн дотоод АЙДИ
  "orgInternalCode": "String", // Ашиглагладаг системийн дотоод регистрийн дугаар
  "orgInternalName": "String", // Ашиглагладаг системийн дотоод нэр
  "createdDate": "Timestamp", // Бүртгэсэн огноо
  "signOrgDate": "Timestamp [Nullable]", // Байгууллага цахми гарын үсэг зурсан огноо
  "signOperatorDate": "Timestamp [Nullable]" // ЦХХХЯ цахим гарын үсэг зурсан огноо
}

Response 403

json
{
  "error": "String", // алдааны мэдээлэл
  "message": "Талбар буруу байна.", // алдааны тайлбар
  "statusCode": 403 // Response code
}

6.2. Байгууллагын гэрээний загвар татах

Байгууллагын гэрээний PDF загварыг бөглөсөн байдлаар татна.

Method: GET

Endpoint:

http
GET https://docx.gov.mn/rest/api/org/contract/download/2

6.3. Байгууллагын гэрээ хуулах

Татаж авсан PDF гэрээ дээр байгууллагын цахим тоон гарын үсгийн зурж буцааж илгээнэ. Файл дээр ямар нэгэн өөрчлөлт хийж болохгүй.

Method: POST

Endpoint:

http
POST https://docx.gov.mn/rest/api/org/contract/upload

Response 201

json
{
  "orgId": "Number", // Docx байгууллагын АЙДИ
  "code": "String - [IsNumber]", // Регистрийн дугаар
  "name": "String", // Байгууллагын нэр
  "shortName": "String - [Nullable]", // Байгууллагын товч нэр
  "docxOrgToken": "String - [Length(256)]", // docxOrgToken цаашид бичиг илгээхэд ашиглана.
  "signOrgDate": "Timestamp", // Байгууллага цахим гарын үсэг зурсан огноо
  "signOperatorDate": "Timestamp - [Nullable]", // ЦХХХЯ цахим гарын үсэг зурсан огноо
  "programId": "Number", // Ашиглагладаг системийн АЙДИ
  "programName": "String", // Ашиглагладаг системийн нэр
  "orgInternalId": "String", // Ашиглагладаг системийн дотоод АЙДИ
  "orgInternalCode": "String", // Ашиглагладаг системийн дотоод регистрийн дугаар
  "orgInternalName": "String" // Ашиглагладаг системийн дотоод нэр
}