POST api/Consortium?systemName={systemName}&username={username}&password={password}

Creates a new consortium

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

Body Parameters

APIConsortium
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

State

Status: Active, Closed or Suspended

string

None.

FirstName

First name of primary contact

string

None.

Surname

Surname of primary contact

string

None.

EmailAddress

Email address of primary contact

string

None.

Company

Company name

string

None.

Address1

First line of address

string

None.

Address2

Second line of address

string

None.

Address3

Third line of address

string

None.

Address4

Fourth line of address

string

None.

County

County of address

string

None.

Postcode

Postcode of address

string

None.

Country

Country of address

string

None.

Telephone

Telephone number

string

None.

CompanyRegistrationNumber

Company registration number

string

None.

VATRegistrationNumber

VAT registration number

string

None.

VATExemptionReferenceNumber

VAT exemption reference number

string

None.

ImpressionCount

Statistics impression count

integer

None.

ClickCount

Statistics click count

integer

None.

Spent

Statistics spent

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "state": "sample string 2",
  "firstName": "sample string 3",
  "surname": "sample string 4",
  "emailAddress": "sample string 5",
  "company": "sample string 6",
  "address1": "sample string 7",
  "address2": "sample string 8",
  "address3": "sample string 9",
  "address4": "sample string 10",
  "county": "sample string 11",
  "postcode": "sample string 12",
  "country": "sample string 13",
  "telephone": "sample string 14",
  "companyRegistrationNumber": "sample string 15",
  "vatRegistrationNumber": "sample string 16",
  "vatExemptionReferenceNumber": "sample string 17",
  "impressionCount": 1,
  "clickCount": 1,
  "spent": 1.1
}

application/xml, text/xml

Sample:
<APIConsortium xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <Address1>sample string 7</Address1>
  <Address2>sample string 8</Address2>
  <Address3>sample string 9</Address3>
  <Address4>sample string 10</Address4>
  <ClickCount>1</ClickCount>
  <Company>sample string 6</Company>
  <CompanyRegistrationNumber>sample string 15</CompanyRegistrationNumber>
  <Country>sample string 13</Country>
  <County>sample string 11</County>
  <EmailAddress>sample string 5</EmailAddress>
  <FirstName>sample string 3</FirstName>
  <Id>1</Id>
  <ImpressionCount>1</ImpressionCount>
  <Postcode>sample string 12</Postcode>
  <Spent>1.1</Spent>
  <State>sample string 2</State>
  <Surname>sample string 4</Surname>
  <Telephone>sample string 14</Telephone>
  <VATExemptionReferenceNumber>sample string 17</VATExemptionReferenceNumber>
  <VATRegistrationNumber>sample string 16</VATRegistrationNumber>
</APIConsortium>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

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