POST api/Signup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SignupID	globally unique identifier	None.
SignupRefID	string	None.
EncryptedRefID	string	None.
UserType	string	None.
FirstName	string	None.
LastName	string	None.
EmailAddress	string	None.
CompanyName	string	None.
RegNo	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
Suburb	string	None.
State	string	None.
PostCode	string	None.
Country	string	None.
PhoneNumber	string	None.
Tariff	string	None.
BankName	string	None.
AccountName	string	None.
AccountNumber	string	None.
BSB	string	None.
Status	string	None.
ConsentNameOne	string	None.
ConsentNameTwo	string	None.
Website	string	None.
BankAddress	string	None.
IBAN	string	None.
IsDirectDebit	boolean	None.
IsVerified	boolean	None.
TariffName	string	None.
MerchantGroup	string	None.
OperatedIndustry	string	None.
CreateNewUser	boolean	None.
SendValidateEmail	boolean	None.
IndustryOther	string	None.
IsBSBVerified	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SignupID": "589e31a3-4c4d-4a31-879c-40f52c8d5802",
  "SignupRefID": "sample string 2",
  "EncryptedRefID": "sample string 3",
  "UserType": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "EmailAddress": "sample string 7",
  "CompanyName": "sample string 8",
  "RegNo": "sample string 9",
  "Address1": "sample string 10",
  "Address2": "sample string 11",
  "City": "sample string 12",
  "Suburb": "sample string 13",
  "State": "sample string 14",
  "PostCode": "sample string 15",
  "Country": "sample string 16",
  "PhoneNumber": "sample string 17",
  "Tariff": "sample string 18",
  "BankName": "sample string 19",
  "AccountName": "sample string 20",
  "AccountNumber": "sample string 21",
  "BSB": "sample string 22",
  "Status": "sample string 23",
  "ConsentNameOne": "sample string 24",
  "ConsentNameTwo": "sample string 25",
  "Website": "sample string 26",
  "BankAddress": "sample string 27",
  "IBAN": "sample string 28",
  "IsDirectDebit": true,
  "IsVerified": true,
  "TariffName": "sample string 31",
  "MerchantGroup": "sample string 32",
  "OperatedIndustry": "sample string 33",
  "CreateNewUser": true,
  "SendValidateEmail": true,
  "IndustryOther": "sample string 36",
  "IsBSBVerified": true
}

application/xml, text/xml

Sample:

<SignupItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Signup">
  <AccountName>sample string 20</AccountName>
  <AccountNumber>sample string 21</AccountNumber>
  <Address1>sample string 10</Address1>
  <Address2>sample string 11</Address2>
  <BSB>sample string 22</BSB>
  <BankAddress>sample string 27</BankAddress>
  <BankName>sample string 19</BankName>
  <City>sample string 12</City>
  <CompanyName>sample string 8</CompanyName>
  <ConsentNameOne>sample string 24</ConsentNameOne>
  <ConsentNameTwo>sample string 25</ConsentNameTwo>
  <Country>sample string 16</Country>
  <CreateNewUser>true</CreateNewUser>
  <EmailAddress>sample string 7</EmailAddress>
  <EncryptedRefID>sample string 3</EncryptedRefID>
  <FirstName>sample string 5</FirstName>
  <IBAN>sample string 28</IBAN>
  <IndustryOther>sample string 36</IndustryOther>
  <IsBSBVerified>true</IsBSBVerified>
  <IsDirectDebit>true</IsDirectDebit>
  <IsVerified>true</IsVerified>
  <LastName>sample string 6</LastName>
  <MerchantGroup>sample string 32</MerchantGroup>
  <OperatedIndustry>sample string 33</OperatedIndustry>
  <PhoneNumber>sample string 17</PhoneNumber>
  <PostCode>sample string 15</PostCode>
  <RegNo>sample string 9</RegNo>
  <SendValidateEmail>true</SendValidateEmail>
  <SignupID>589e31a3-4c4d-4a31-879c-40f52c8d5802</SignupID>
  <SignupRefID>sample string 2</SignupRefID>
  <State>sample string 14</State>
  <Status>sample string 23</Status>
  <Suburb>sample string 13</Suburb>
  <Tariff>sample string 18</Tariff>
  <TariffName>sample string 31</TariffName>
  <UserType>sample string 4</UserType>
  <Website>sample string 26</Website>
</SignupItem>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SignupItem'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

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