POST api/Forms/Request

Request Information

URI Parameters

None.

Body Parameters

Request
NameDescriptionTypeAdditional information
CustomerTitle

string

None.

CustomerForeName

string

None.

CustomerSurname

string

None.

CustomerAddress1

string

None.

CustomerAddress2

string

None.

TownCity

string

None.

PostCode

string

None.

TelephoneNumber

string

None.

NumberRequested

integer

None.

FormTypeId

integer

None.

FormFormatId

integer

None.

OriginatingOfficeId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerTitle": "sample string 1",
  "CustomerForeName": "sample string 2",
  "CustomerSurname": "sample string 3",
  "CustomerAddress1": "sample string 4",
  "CustomerAddress2": "sample string 5",
  "TownCity": "sample string 6",
  "PostCode": "sample string 7",
  "TelephoneNumber": "sample string 8",
  "NumberRequested": 9,
  "FormTypeId": 10,
  "FormFormatId": 11,
  "OriginatingOfficeId": 12
}

text/html

Sample:
{"CustomerTitle":"sample string 1","CustomerForeName":"sample string 2","CustomerSurname":"sample string 3","CustomerAddress1":"sample string 4","CustomerAddress2":"sample string 5","TownCity":"sample string 6","PostCode":"sample string 7","TelephoneNumber":"sample string 8","NumberRequested":9,"FormTypeId":10,"FormFormatId":11,"OriginatingOfficeId":12}

application/xml, text/xml

Sample:
<Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ldl.MessageBroker.Service.FormsRequest.Models">
  <CustomerAddress1>sample string 4</CustomerAddress1>
  <CustomerAddress2>sample string 5</CustomerAddress2>
  <CustomerForeName>sample string 2</CustomerForeName>
  <CustomerSurname>sample string 3</CustomerSurname>
  <CustomerTitle>sample string 1</CustomerTitle>
  <FormFormatId>11</FormFormatId>
  <FormTypeId>10</FormTypeId>
  <NumberRequested>9</NumberRequested>
  <OriginatingOfficeId>12</OriginatingOfficeId>
  <PostCode>sample string 7</PostCode>
  <TelephoneNumber>sample string 8</TelephoneNumber>
  <TownCity>sample string 6</TownCity>
</Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.