POST api/NTOrderSettings/PostOrderProtocols

Request Information

URI Parameters

None.

Body Parameters

ProtocolDTO
NameDescriptionTypeAdditional information
Id

integer

None.
Protocols

string

String length: inclusive between 0 and 8000
Name

string

String length: inclusive between 0 and 1000
ExamCustomName

string

String length: inclusive between 0 and 1000
CorporationCode

string

String length: inclusive between 0 and 20
EntityTypeId

integer

None.
EntityId

string

String length: inclusive between 0 and 200
path

string

String length: inclusive between 0 and 8000
DocumentList

Collection of ProtocolDocumentDTO

None.
ValidFlag

boolean

None.
DateCreated

date

None.
DateUpdated

date

None.
UserIDCreated

integer

None.
UserIDUpdated

integer

None.
CompanyCode

string

String length: inclusive between 0 and 20
IsExcludeDiscount

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Protocols": "sample string 2",
  "Name": "sample string 3",
  "ExamCustomName": "sample string 4",
  "CorporationCode": "sample string 5",
  "EntityTypeId": 6,
  "EntityId": "sample string 7",
  "path": "sample string 8",
  "DocumentList": [
    {
      "Path": "sample string 1",
      "DocumentName": "sample string 2",
      "ProtocolId": 3,
      "ValidFlag": true,
      "DateCreated": "2025-04-06T04:42:57.0848727-07:00",
      "DateUpdated": "2025-04-06T04:42:57.0848727-07:00",
      "UserIDCreated": 7,
      "UserIDUpdated": 8,
      "CompanyCode": "sample string 9",
      "IsExcludeDiscount": true
    },
    {
      "Path": "sample string 1",
      "DocumentName": "sample string 2",
      "ProtocolId": 3,
      "ValidFlag": true,
      "DateCreated": "2025-04-06T04:42:57.0848727-07:00",
      "DateUpdated": "2025-04-06T04:42:57.0848727-07:00",
      "UserIDCreated": 7,
      "UserIDUpdated": 8,
      "CompanyCode": "sample string 9",
      "IsExcludeDiscount": true
    }
  ],
  "ValidFlag": true,
  "DateCreated": "2025-04-06T04:42:57.0848727-07:00",
  "DateUpdated": "2025-04-06T04:42:57.0848727-07:00",
  "UserIDCreated": 12,
  "UserIDUpdated": 13,
  "CompanyCode": "sample string 14",
  "IsExcludeDiscount": true
}

application/xml, text/xml

Sample: 
<ProtocolDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
  <CompanyCode>sample string 14</CompanyCode>
  <DateCreated>2025-04-06T04:42:57.0848727-07:00</DateCreated>
  <DateUpdated>2025-04-06T04:42:57.0848727-07:00</DateUpdated>
  <IsExcludeDiscount>true</IsExcludeDiscount>
  <UserIDCreated>12</UserIDCreated>
  <UserIDUpdated>13</UserIDUpdated>
  <ValidFlag>true</ValidFlag>
  <CorporationCode>sample string 5</CorporationCode>
  <DocumentList>
    <ProtocolDocumentDTO>
      <CompanyCode>sample string 9</CompanyCode>
      <DateCreated>2025-04-06T04:42:57.0848727-07:00</DateCreated>
      <DateUpdated>2025-04-06T04:42:57.0848727-07:00</DateUpdated>
      <IsExcludeDiscount>true</IsExcludeDiscount>
      <UserIDCreated>7</UserIDCreated>
      <UserIDUpdated>8</UserIDUpdated>
      <ValidFlag>true</ValidFlag>
      <DocumentName>sample string 2</DocumentName>
      <Path>sample string 1</Path>
      <ProtocolId>3</ProtocolId>
    </ProtocolDocumentDTO>
    <ProtocolDocumentDTO>
      <CompanyCode>sample string 9</CompanyCode>
      <DateCreated>2025-04-06T04:42:57.0848727-07:00</DateCreated>
      <DateUpdated>2025-04-06T04:42:57.0848727-07:00</DateUpdated>
      <IsExcludeDiscount>true</IsExcludeDiscount>
      <UserIDCreated>7</UserIDCreated>
      <UserIDUpdated>8</UserIDUpdated>
      <ValidFlag>true</ValidFlag>
      <DocumentName>sample string 2</DocumentName>
      <Path>sample string 1</Path>
      <ProtocolId>3</ProtocolId>
    </ProtocolDocumentDTO>
  </DocumentList>
  <EntityId>sample string 7</EntityId>
  <EntityTypeId>6</EntityTypeId>
  <ExamCustomName>sample string 4</ExamCustomName>
  <Id>1</Id>
  <Name>sample string 3</Name>
  <Protocols>sample string 2</Protocols>
  <path>sample string 8</path>
</ProtocolDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfProtocolDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.
message

string

None.
jsonObj

ProtocolDTO

None.
totalCount

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "Id": 1,
    "Protocols": "sample string 2",
    "Name": "sample string 3",
    "ExamCustomName": "sample string 4",
    "CorporationCode": "sample string 5",
    "EntityTypeId": 6,
    "EntityId": "sample string 7",
    "path": "sample string 8",
    "DocumentList": [
      {
        "Path": "sample string 1",
        "DocumentName": "sample string 2",
        "ProtocolId": 3,
        "ValidFlag": true,
        "DateCreated": "2025-04-06T04:42:57.113898-07:00",
        "DateUpdated": "2025-04-06T04:42:57.113898-07:00",
        "UserIDCreated": 7,
        "UserIDUpdated": 8,
        "CompanyCode": "sample string 9",
        "IsExcludeDiscount": true
      },
      {
        "Path": "sample string 1",
        "DocumentName": "sample string 2",
        "ProtocolId": 3,
        "ValidFlag": true,
        "DateCreated": "2025-04-06T04:42:57.113898-07:00",
        "DateUpdated": "2025-04-06T04:42:57.113898-07:00",
        "UserIDCreated": 7,
        "UserIDUpdated": 8,
        "CompanyCode": "sample string 9",
        "IsExcludeDiscount": true
      }
    ],
    "ValidFlag": true,
    "DateCreated": "2025-04-06T04:42:57.113898-07:00",
    "DateUpdated": "2025-04-06T04:42:57.113898-07:00",
    "UserIDCreated": 12,
    "UserIDUpdated": 13,
    "CompanyCode": "sample string 14",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}

application/xml, text/xml

Sample: 
<AsapResponseOfProtocolDTO3NYuOdgi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.Common">
  <isSuccess>true</isSuccess>
  <jsonObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
    <d2p1:CompanyCode>sample string 14</d2p1:CompanyCode>
    <d2p1:DateCreated>2025-04-06T04:42:57.113898-07:00</d2p1:DateCreated>
    <d2p1:DateUpdated>2025-04-06T04:42:57.113898-07:00</d2p1:DateUpdated>
    <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
    <d2p1:UserIDCreated>12</d2p1:UserIDCreated>
    <d2p1:UserIDUpdated>13</d2p1:UserIDUpdated>
    <d2p1:ValidFlag>true</d2p1:ValidFlag>
    <d2p1:CorporationCode>sample string 5</d2p1:CorporationCode>
    <d2p1:DocumentList>
      <d2p1:ProtocolDocumentDTO>
        <d2p1:CompanyCode>sample string 9</d2p1:CompanyCode>
        <d2p1:DateCreated>2025-04-06T04:42:57.113898-07:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2025-04-06T04:42:57.113898-07:00</d2p1:DateUpdated>
        <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
        <d2p1:UserIDCreated>7</d2p1:UserIDCreated>
        <d2p1:UserIDUpdated>8</d2p1:UserIDUpdated>
        <d2p1:ValidFlag>true</d2p1:ValidFlag>
        <d2p1:DocumentName>sample string 2</d2p1:DocumentName>
        <d2p1:Path>sample string 1</d2p1:Path>
        <d2p1:ProtocolId>3</d2p1:ProtocolId>
      </d2p1:ProtocolDocumentDTO>
      <d2p1:ProtocolDocumentDTO>
        <d2p1:CompanyCode>sample string 9</d2p1:CompanyCode>
        <d2p1:DateCreated>2025-04-06T04:42:57.113898-07:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2025-04-06T04:42:57.113898-07:00</d2p1:DateUpdated>
        <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
        <d2p1:UserIDCreated>7</d2p1:UserIDCreated>
        <d2p1:UserIDUpdated>8</d2p1:UserIDUpdated>
        <d2p1:ValidFlag>true</d2p1:ValidFlag>
        <d2p1:DocumentName>sample string 2</d2p1:DocumentName>
        <d2p1:Path>sample string 1</d2p1:Path>
        <d2p1:ProtocolId>3</d2p1:ProtocolId>
      </d2p1:ProtocolDocumentDTO>
    </d2p1:DocumentList>
    <d2p1:EntityId>sample string 7</d2p1:EntityId>
    <d2p1:EntityTypeId>6</d2p1:EntityTypeId>
    <d2p1:ExamCustomName>sample string 4</d2p1:ExamCustomName>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Protocols>sample string 2</d2p1:Protocols>
    <d2p1:path>sample string 8</d2p1:path>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfProtocolDTO3NYuOdgi>