POST api/order/data

Adding new license from external source

Request Information

URI Parameters

None.

Body Parameters

New license order informations.

OrderRequest
NameDescriptionTypeAdditional information
Action

string

None.

Owner

LicenseOwnerRequest

None.

Target

TargetRequest

None.

StartDate

string

None.

EndDate

string

None.

Ean

string

None.

Security

string

None.

Contact

ContactRequest

None.

Quantity

integer

None.

Grade

string

None.

AccessType

string

None.

LicenseType

string

None.

OrderRef

string

None.

AllowableUserRoles

string

None.

PrivilegedUserRoles

string

None.

PreSet

string

None.

SubscriptionNumber

string

None.

Agreement

Agreement

None.

Subscription

SubscriptionRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "Action": "sample string 1",
  "Owner": {
    "Type": "sample string 1",
    "Identifier": "sample string 2",
    "Name": "sample string 3",
    "Address": {
      "Street": "sample string 1",
      "City": "sample string 2",
      "ZipCode": "sample string 3"
    },
    "Contact": {
      "Email": "sample string 1",
      "PhoneNumber": "sample string 2",
      "PersonName": "sample string 3"
    }
  },
  "Target": {
    "Type": "sample string 1",
    "Identifier": "sample string 2",
    "Name": "sample string 3",
    "ClassIdentifiers": "sample string 4"
  },
  "StartDate": "sample string 2",
  "EndDate": "sample string 3",
  "Ean": "sample string 4",
  "Security": "sample string 5",
  "Contact": {
    "Email": "sample string 1",
    "PhoneNumber": "sample string 2",
    "PersonName": "sample string 3"
  },
  "Quantity": 6,
  "Grade": "sample string 7",
  "AccessType": "sample string 8",
  "LicenseType": "sample string 9",
  "OrderRef": "sample string 10",
  "AllowableUserRoles": "sample string 11",
  "PrivilegedUserRoles": "sample string 12",
  "PreSet": "sample string 13",
  "SubscriptionNumber": "sample string 14",
  "Agreement": {
    "AgreementNo": "sample string 1",
    "MunicipalNo": "sample string 2",
    "MunicipalAgreement": "sample string 3",
    "AgreementStartDate": "sample string 4",
    "AgreementEndDate": "sample string 5",
    "NoOfMonthInvoiced": "sample string 6",
    "NoOfMonthAgreement": "sample string 7",
    "TotalAmount": 8.0,
    "RemainingAmount": 9.0,
    "MunicipalName": "sample string 10",
    "ContactNo": "sample string 11",
    "ActualAmount": 12.0,
    "ContactName": "sample string 13",
    "LineDiscount": 14.0,
    "LineDiscountAmount": 15.0
  },
  "Subscription": {
    "SubscriptionNumber": "sample string 1",
    "SubscriptionStartDate": "sample string 2",
    "SubscriptionEndDate": "sample string 3"
  },
  "Source": "sample string 15",
  "AccountId": "2c8a5def-2cfe-40f9-8927-aa539835aaee"
}

application/xml, text/xml

Sample:
<OrderRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Action>sample string 1</Action>
  <Owner>
    <Type>sample string 1</Type>
    <Identifier>sample string 2</Identifier>
    <Name>sample string 3</Name>
    <Address>
      <Street>sample string 1</Street>
      <City>sample string 2</City>
      <ZipCode>sample string 3</ZipCode>
    </Address>
    <Contact>
      <Email>sample string 1</Email>
      <PhoneNumber>sample string 2</PhoneNumber>
      <PersonName>sample string 3</PersonName>
    </Contact>
  </Owner>
  <Target>
    <Type>sample string 1</Type>
    <Identifier>sample string 2</Identifier>
    <Name>sample string 3</Name>
    <ClassIdentifiers>sample string 4</ClassIdentifiers>
  </Target>
  <StartDate>sample string 2</StartDate>
  <EndDate>sample string 3</EndDate>
  <Ean>sample string 4</Ean>
  <Security>sample string 5</Security>
  <Contact>
    <Email>sample string 1</Email>
    <PhoneNumber>sample string 2</PhoneNumber>
    <PersonName>sample string 3</PersonName>
  </Contact>
  <Quantity>6</Quantity>
  <Grade>sample string 7</Grade>
  <AccessType>sample string 8</AccessType>
  <LicenseType>sample string 9</LicenseType>
  <OrderRef>sample string 10</OrderRef>
  <AllowableUserRoles>sample string 11</AllowableUserRoles>
  <PrivilegedUserRoles>sample string 12</PrivilegedUserRoles>
  <PreSet>sample string 13</PreSet>
  <SubscriptionNumber>sample string 14</SubscriptionNumber>
  <Agreement>
    <AgreementNo>sample string 1</AgreementNo>
    <MunicipalNo>sample string 2</MunicipalNo>
    <MunicipalAgreement>sample string 3</MunicipalAgreement>
    <AgreementStartDate>sample string 4</AgreementStartDate>
    <AgreementEndDate>sample string 5</AgreementEndDate>
    <NoOfMonthInvoiced>sample string 6</NoOfMonthInvoiced>
    <NoOfMonthAgreement>sample string 7</NoOfMonthAgreement>
    <TotalAmount>8</TotalAmount>
    <RemainingAmount>9</RemainingAmount>
    <MunicipalName>sample string 10</MunicipalName>
    <ContactNo>sample string 11</ContactNo>
    <ActualAmount>12</ActualAmount>
    <ContactName>sample string 13</ContactName>
    <LineDiscount>14</LineDiscount>
    <LineDiscountAmount>15</LineDiscountAmount>
  </Agreement>
  <Subscription>
    <SubscriptionNumber>sample string 1</SubscriptionNumber>
    <SubscriptionStartDate>sample string 2</SubscriptionStartDate>
    <SubscriptionEndDate>sample string 3</SubscriptionEndDate>
  </Subscription>
</OrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Resonse if license pass validation.

ValidationResult
NameDescriptionTypeAdditional information
IsValid

boolean

None.

Errors

Collection of ValidationFailure

None.

Response Formats

application/json, text/json

Sample:
{
  "errors": []
}

application/xml, text/xml

Sample:
<ValidationResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />