POST utility/registration

Post for a typed object of Registration

Request Information

URI Parameters

None.

Body Parameters

Registration
NameDescriptionTypeAdditional information
captcha

string

None.

test

boolean

None.

submitterParty

SubmitterParty

None.

answers

Collection of Answer

None.

product

OwnedProduct

None.

subscriber

Subscriber

None.

reference

Reference

None.

Request Formats

application/json, text/json

Sample:
{
  "captcha": "sample string 1",
  "test": true,
  "submitterParty": {
    "Id": "sample string 1",
    "ManufactureType": "sample string 2",
    "Name": "sample string 3",
    "Email": "sample string 4"
  },
  "answers": [
    {
      "QuestionID": 1,
      "AnswerID": 2,
      "TextAnswer": "sample string 3"
    },
    {
      "QuestionID": 1,
      "AnswerID": 2,
      "TextAnswer": "sample string 3"
    }
  ],
  "product": {
    "ModelNumber": "sample string 1",
    "SerialNumber": "sample string 2",
    "PurchaseDate": "2018-12-16T00:00:00-06:00",
    "EquipmentType": "sample string 4",
    "ManufactureType": "sample string 5"
  },
  "subscriber": {
    "Prefix": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "Country": "sample string 9",
    "PhoneNumber": "sample string 10",
    "Company": "sample string 11"
  },
  "reference": {
    "Id": "sample string 1",
    "Date": "2018-12-16T20:54:02.7286376-06:00"
  }
}

application/xml, text/xml

Sample:
<Registration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/External_Services.Models.DAO">
  <answers>
    <Answer>
      <AnswerID>2</AnswerID>
      <QuestionID>1</QuestionID>
      <TextAnswer>sample string 3</TextAnswer>
    </Answer>
    <Answer>
      <AnswerID>2</AnswerID>
      <QuestionID>1</QuestionID>
      <TextAnswer>sample string 3</TextAnswer>
    </Answer>
  </answers>
  <captcha>sample string 1</captcha>
  <product>
    <EquipmentType>sample string 4</EquipmentType>
    <ManufactureType>sample string 5</ManufactureType>
    <ModelNumber>sample string 1</ModelNumber>
    <PurchaseDate>2018-12-16T00:00:00-06:00</PurchaseDate>
    <SerialNumber>sample string 2</SerialNumber>
  </product>
  <reference>
    <Date>2018-12-16T20:54:02.7286376-06:00</Date>
    <Id>sample string 1</Id>
  </reference>
  <submitterParty>
    <Email>sample string 4</Email>
    <Id>sample string 1</Id>
    <ManufactureType>sample string 2</ManufactureType>
    <Name>sample string 3</Name>
  </submitterParty>
  <subscriber>
    <Address1>sample string 4</Address1>
    <Address2>sample string 5</Address2>
    <City>sample string 6</City>
    <Company>sample string 11</Company>
    <Country>sample string 9</Country>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <PhoneNumber>sample string 10</PhoneNumber>
    <Prefix>sample string 1</Prefix>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
  </subscriber>
  <test>true</test>
</Registration>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SubscriberResponse
NameDescriptionTypeAdditional information
ReturnCode

Code return from each web api call

integer

None.

Message

Message sent back for success

string

None.

Success

Call succeeded

boolean

None.

warrantyCode

Returns a warranty type code - 0 if nothing, 1 - extended

integer

None.

partNum

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ReturnCode": 1,
  "Message": "sample string 2",
  "Success": true,
  "warrantyCode": 4,
  "partNum": "sample string 5"
}

application/xml, text/xml

Sample:
<SubscriberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/External_Services.Models.DAO">
  <Message>sample string 2</Message>
  <ReturnCode>1</ReturnCode>
  <Success>true</Success>
  <partNum>sample string 5</partNum>
  <warrantyCode>4</warrantyCode>
</SubscriberResponse>