POST api/NTOrderSettings

Request Information

URI Parameters

None.

Body Parameters

CorporationOrderAuthorizationDTO
NameDescriptionTypeAdditional information
Id

integer

None.

OrderTypeId

string

String length: inclusive between 0 and 8000

OrderCategoryId

integer

None.

CorporationCode

string

String length: inclusive between 0 and 20

IsAuthorizationRequired

boolean

None.

Name

string

String length: inclusive between 0 and 100

ExamCustomName

string

String length: inclusive between 0 and 100

SubTypeName

string

String length: inclusive between 0 and 100

Sequence

integer

None.

Customstatus

boolean

None.

Protocols

string

String length: inclusive between 0 and 4000

StandardProtocols

string

String length: inclusive between 0 and 8000

IsCustome

boolean

None.

Description

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,
  "OrderTypeId": "sample string 2",
  "OrderCategoryId": 3,
  "CorporationCode": "sample string 4",
  "IsAuthorizationRequired": true,
  "Name": "sample string 6",
  "ExamCustomName": "sample string 7",
  "SubTypeName": "sample string 8",
  "Sequence": 9,
  "Customstatus": true,
  "Protocols": "sample string 11",
  "StandardProtocols": "sample string 12",
  "IsCustome": true,
  "Description": "sample string 14",
  "DocumentList": [
    {
      "Path": "sample string 1",
      "DocumentName": "sample string 2",
      "ProtocolId": 3,
      "ValidFlag": true,
      "DateCreated": "2024-11-21T00:34:48.4653334-08:00",
      "DateUpdated": "2024-11-21T00:34:48.4653334-08:00",
      "UserIDCreated": 7,
      "UserIDUpdated": 8,
      "CompanyCode": "sample string 9",
      "IsExcludeDiscount": true
    },
    {
      "Path": "sample string 1",
      "DocumentName": "sample string 2",
      "ProtocolId": 3,
      "ValidFlag": true,
      "DateCreated": "2024-11-21T00:34:48.4653334-08:00",
      "DateUpdated": "2024-11-21T00:34:48.4653334-08:00",
      "UserIDCreated": 7,
      "UserIDUpdated": 8,
      "CompanyCode": "sample string 9",
      "IsExcludeDiscount": true
    }
  ],
  "ValidFlag": true,
  "DateCreated": "2024-11-21T00:34:48.4653334-08:00",
  "DateUpdated": "2024-11-21T00:34:48.4653334-08:00",
  "UserIDCreated": 18,
  "UserIDUpdated": 19,
  "CompanyCode": "sample string 20",
  "IsExcludeDiscount": true
}

application/xml, text/xml

Sample:
<CorporationOrderAuthorizationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
  <CompanyCode>sample string 20</CompanyCode>
  <DateCreated>2024-11-21T00:34:48.4653334-08:00</DateCreated>
  <DateUpdated>2024-11-21T00:34:48.4653334-08:00</DateUpdated>
  <IsExcludeDiscount>true</IsExcludeDiscount>
  <UserIDCreated>18</UserIDCreated>
  <UserIDUpdated>19</UserIDUpdated>
  <ValidFlag>true</ValidFlag>
  <CorporationCode>sample string 4</CorporationCode>
  <Customstatus>true</Customstatus>
  <Description>sample string 14</Description>
  <DocumentList>
    <ProtocolDocumentDTO>
      <CompanyCode>sample string 9</CompanyCode>
      <DateCreated>2024-11-21T00:34:48.4653334-08:00</DateCreated>
      <DateUpdated>2024-11-21T00:34:48.4653334-08: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>2024-11-21T00:34:48.4653334-08:00</DateCreated>
      <DateUpdated>2024-11-21T00:34:48.4653334-08: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>
  <ExamCustomName>sample string 7</ExamCustomName>
  <Id>1</Id>
  <IsAuthorizationRequired>true</IsAuthorizationRequired>
  <IsCustome>true</IsCustome>
  <Name>sample string 6</Name>
  <OrderCategoryId>3</OrderCategoryId>
  <OrderTypeId>sample string 2</OrderTypeId>
  <Protocols>sample string 11</Protocols>
  <Sequence>9</Sequence>
  <StandardProtocols>sample string 12</StandardProtocols>
  <SubTypeName>sample string 8</SubTypeName>
</CorporationOrderAuthorizationDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfCorporationOrderAuthorizationDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

message

string

None.

jsonObj

CorporationOrderAuthorizationDTO

None.

totalCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "Id": 1,
    "OrderTypeId": "sample string 2",
    "OrderCategoryId": 3,
    "CorporationCode": "sample string 4",
    "IsAuthorizationRequired": true,
    "Name": "sample string 6",
    "ExamCustomName": "sample string 7",
    "SubTypeName": "sample string 8",
    "Sequence": 9,
    "Customstatus": true,
    "Protocols": "sample string 11",
    "StandardProtocols": "sample string 12",
    "IsCustome": true,
    "Description": "sample string 14",
    "DocumentList": [
      {
        "Path": "sample string 1",
        "DocumentName": "sample string 2",
        "ProtocolId": 3,
        "ValidFlag": true,
        "DateCreated": "2024-11-21T00:34:48.5009744-08:00",
        "DateUpdated": "2024-11-21T00:34:48.5009744-08:00",
        "UserIDCreated": 7,
        "UserIDUpdated": 8,
        "CompanyCode": "sample string 9",
        "IsExcludeDiscount": true
      },
      {
        "Path": "sample string 1",
        "DocumentName": "sample string 2",
        "ProtocolId": 3,
        "ValidFlag": true,
        "DateCreated": "2024-11-21T00:34:48.5009744-08:00",
        "DateUpdated": "2024-11-21T00:34:48.5009744-08:00",
        "UserIDCreated": 7,
        "UserIDUpdated": 8,
        "CompanyCode": "sample string 9",
        "IsExcludeDiscount": true
      }
    ],
    "ValidFlag": true,
    "DateCreated": "2024-11-21T00:34:48.5009744-08:00",
    "DateUpdated": "2024-11-21T00:34:48.5009744-08:00",
    "UserIDCreated": 18,
    "UserIDUpdated": 19,
    "CompanyCode": "sample string 20",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:
<AsapResponseOfCorporationOrderAuthorizationDTO3NYuOdgi 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 20</d2p1:CompanyCode>
    <d2p1:DateCreated>2024-11-21T00:34:48.5009744-08:00</d2p1:DateCreated>
    <d2p1:DateUpdated>2024-11-21T00:34:48.5009744-08:00</d2p1:DateUpdated>
    <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
    <d2p1:UserIDCreated>18</d2p1:UserIDCreated>
    <d2p1:UserIDUpdated>19</d2p1:UserIDUpdated>
    <d2p1:ValidFlag>true</d2p1:ValidFlag>
    <d2p1:CorporationCode>sample string 4</d2p1:CorporationCode>
    <d2p1:Customstatus>true</d2p1:Customstatus>
    <d2p1:Description>sample string 14</d2p1:Description>
    <d2p1:DocumentList>
      <d2p1:ProtocolDocumentDTO>
        <d2p1:CompanyCode>sample string 9</d2p1:CompanyCode>
        <d2p1:DateCreated>2024-11-21T00:34:48.5009744-08:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2024-11-21T00:34:48.5009744-08: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>2024-11-21T00:34:48.5009744-08:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2024-11-21T00:34:48.5009744-08: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:ExamCustomName>sample string 7</d2p1:ExamCustomName>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsAuthorizationRequired>true</d2p1:IsAuthorizationRequired>
    <d2p1:IsCustome>true</d2p1:IsCustome>
    <d2p1:Name>sample string 6</d2p1:Name>
    <d2p1:OrderCategoryId>3</d2p1:OrderCategoryId>
    <d2p1:OrderTypeId>sample string 2</d2p1:OrderTypeId>
    <d2p1:Protocols>sample string 11</d2p1:Protocols>
    <d2p1:Sequence>9</d2p1:Sequence>
    <d2p1:StandardProtocols>sample string 12</d2p1:StandardProtocols>
    <d2p1:SubTypeName>sample string 8</d2p1:SubTypeName>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfCorporationOrderAuthorizationDTO3NYuOdgi>