POST api/SerialNumber

Add SerialNumber

Request Information

URI Parameters

None.

Body Parameters

Message with serial number items to add

Name	Type	Additional information
Header	MessageHeader	None.
SerialNumbers	Collection of SerialNumberPostItem	None.
Footer	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SerialNumbers": [
    {
      "SerialNumberIdentifier": "string 1",
      "CompanyIdentifier": "string 2",
      "ProductIdentifier": "string 3",
      "IsValidated": true
    },
    {
      "SerialNumberIdentifier": "string 1",
      "CompanyIdentifier": "string 2",
      "ProductIdentifier": "string 3",
      "IsValidated": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PostSerialNumberMessageRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <SerialNumbers>
    <SerialNumberPostItem>
      <SerialNumberIdentifier>string 1</SerialNumberIdentifier>
      <CompanyIdentifier>string 2</CompanyIdentifier>
      <ProductIdentifier>string 3</ProductIdentifier>
      <IsValidated>true</IsValidated>
    </SerialNumberPostItem>
    <SerialNumberPostItem>
      <SerialNumberIdentifier>string 1</SerialNumberIdentifier>
      <CompanyIdentifier>string 2</CompanyIdentifier>
      <ProductIdentifier>string 3</ProductIdentifier>
      <IsValidated>true</IsValidated>
    </SerialNumberPostItem>
  </SerialNumbers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PostSerialNumberMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Ok: Message with result. Invalid APIKey: HttpStatusCode.Conflict

PostSerialNumberMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
SerialNumbers	Collection of SerialNumberPostResult	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SerialNumbers": [
    {
      "ProcessingStatus": "P",
      "SerialNumberImportResult": "string 1",
      "SerialNumberIdentifier": "string 2",
      "CompanyIdentifier": "string 3",
      "ProductIdentifier": "string 4",
      "IsValidated": true
    },
    {
      "ProcessingStatus": "P",
      "SerialNumberImportResult": "string 1",
      "SerialNumberIdentifier": "string 2",
      "CompanyIdentifier": "string 3",
      "ProductIdentifier": "string 4",
      "IsValidated": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PostSerialNumberMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <SerialNumbers>
    <SerialNumberPostResult>
      <SerialNumberIdentifier>string 2</SerialNumberIdentifier>
      <CompanyIdentifier>string 3</CompanyIdentifier>
      <ProductIdentifier>string 4</ProductIdentifier>
      <IsValidated>true</IsValidated>
      <ProcessingStatus>P</ProcessingStatus>
      <SerialNumberImportResult>string 1</SerialNumberImportResult>
    </SerialNumberPostResult>
    <SerialNumberPostResult>
      <SerialNumberIdentifier>string 2</SerialNumberIdentifier>
      <CompanyIdentifier>string 3</CompanyIdentifier>
      <ProductIdentifier>string 4</ProductIdentifier>
      <IsValidated>true</IsValidated>
      <ProcessingStatus>P</ProcessingStatus>
      <SerialNumberImportResult>string 1</SerialNumberImportResult>
    </SerialNumberPostResult>
  </SerialNumbers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PostSerialNumberMessageResponse>