POST public/Plan/CRMSignup
Request Information
URI Parameters
None.
Body Parameters
SignupViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Client | ClientViewModel |
Required |
|
| Plan | PlanDetailViewModel |
Required |
|
| Card | CardViewModel |
None. |
|
| User | SignupUserViewModel |
None. |
|
| ProductUrl | string |
Matching regular expression pattern: ^[a-zA-Z][a-zA-Z0-9]*$ |
|
| ProductLoginUrl | string |
None. |
|
| Quotes | Collection of string |
None. |
|
| Modules | Collection of string |
None. |
|
| SkipSignupEmail | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Client": {
"ClientId": 1,
"Name": "sample string 2",
"TimeZone": "sample string 3",
"Culture": "sample string 4",
"ShortName": "sample string 5",
"OrganizationType": "sample string 6",
"ContactFirstName": "sample string 7",
"ContactMiddleName": "sample string 8",
"ContactLastName": "sample string 9",
"ContactPhone": "sample string 10",
"CountryCode": "sample string 11",
"CountryPhoneCode": "sample string 12",
"ContactEmail": "sample string 13",
"ContactTitle": "sample string 14",
"Address": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"StateRegionProvince": "sample string 7",
"PostalCode": "sample string 8",
"Plus4Code": "sample string 9",
"Country": "sample string 10"
},
"BillingAddress": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"StateRegionProvince": "sample string 7",
"PostalCode": "sample string 8",
"Plus4Code": "sample string 9",
"Country": "sample string 10"
},
"Logo": "sample string 15",
"Website": "sample string 16"
},
"Plan": {
"PlanId": 1,
"PlanTypeId": "Metered",
"CoupenCode": "sample string 2",
"ProductId": 3,
"IsTrial": true,
"Product": "sample string 5",
"ContractCode": "sample string 6",
"DiscountApplicable": "sample string 7",
"AdditionalInfo": {
"ContractContents": [
{
"ContentId": 1,
"SectionInitials": "sample string 2",
"Content": "sample string 3",
"SignedDate": "sample string 4"
},
{
"ContentId": 1,
"SectionInitials": "sample string 2",
"Content": "sample string 3",
"SignedDate": "sample string 4"
}
],
"SignedContractUrl": "sample string 1"
}
},
"Card": {
"CardNo": "sample string 1",
"CVV": "sample string 2",
"CardFirstName": "sample string 3",
"CardLastName": "sample string 4",
"CardExpiryMonth": 5,
"CardExpiryYear": 6,
"CardToken": "sample string 7"
},
"User": {
"UserName": "sample string 1",
"Password": "sample string 2"
},
"ProductUrl": "sample string 1",
"ProductLoginUrl": "sample string 2",
"Quotes": [
"sample string 1",
"sample string 2"
],
"Modules": [
"sample string 1",
"sample string 2"
],
"SkipSignupEmail": true
}
application/xml, text/xml
Sample:
<SignupViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accounts.ModelBuilder.Library.ViewModels.Plan">
<Card>
<CVV>sample string 2</CVV>
<CardExpiryMonth>5</CardExpiryMonth>
<CardExpiryYear>6</CardExpiryYear>
<CardFirstName>sample string 3</CardFirstName>
<CardLastName>sample string 4</CardLastName>
<CardNo>sample string 1</CardNo>
<CardToken>sample string 7</CardToken>
</Card>
<Client>
<Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Account.DTO.Library.MyAccount">
<d3p1:AddressLine1>sample string 1</d3p1:AddressLine1>
<d3p1:AddressLine2>sample string 2</d3p1:AddressLine2>
<d3p1:AddressLine3>sample string 3</d3p1:AddressLine3>
<d3p1:AddressLine4>sample string 4</d3p1:AddressLine4>
<d3p1:City>sample string 5</d3p1:City>
<d3p1:Country>sample string 10</d3p1:Country>
<d3p1:County>sample string 6</d3p1:County>
<d3p1:Plus4Code>sample string 9</d3p1:Plus4Code>
<d3p1:PostalCode>sample string 8</d3p1:PostalCode>
<d3p1:StateRegionProvince>sample string 7</d3p1:StateRegionProvince>
</Address>
<BillingAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Account.DTO.Library.MyAccount">
<d3p1:AddressLine1>sample string 1</d3p1:AddressLine1>
<d3p1:AddressLine2>sample string 2</d3p1:AddressLine2>
<d3p1:AddressLine3>sample string 3</d3p1:AddressLine3>
<d3p1:AddressLine4>sample string 4</d3p1:AddressLine4>
<d3p1:City>sample string 5</d3p1:City>
<d3p1:Country>sample string 10</d3p1:Country>
<d3p1:County>sample string 6</d3p1:County>
<d3p1:Plus4Code>sample string 9</d3p1:Plus4Code>
<d3p1:PostalCode>sample string 8</d3p1:PostalCode>
<d3p1:StateRegionProvince>sample string 7</d3p1:StateRegionProvince>
</BillingAddress>
<ClientId>1</ClientId>
<ContactEmail>sample string 13</ContactEmail>
<ContactFirstName>sample string 7</ContactFirstName>
<ContactLastName>sample string 9</ContactLastName>
<ContactMiddleName>sample string 8</ContactMiddleName>
<ContactPhone>sample string 10</ContactPhone>
<ContactTitle>sample string 14</ContactTitle>
<CountryCode>sample string 11</CountryCode>
<CountryPhoneCode>sample string 12</CountryPhoneCode>
<Culture>sample string 4</Culture>
<Logo>sample string 15</Logo>
<Name>sample string 2</Name>
<OrganizationType>sample string 6</OrganizationType>
<ShortName>sample string 5</ShortName>
<TimeZone>sample string 3</TimeZone>
<Website>sample string 16</Website>
</Client>
<Modules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Modules>
<Plan>
<AdditionalInfo>
<ContractContents>
<SignedContract>
<Content>sample string 3</Content>
<ContentId>1</ContentId>
<SectionInitials>sample string 2</SectionInitials>
<SignedDate>sample string 4</SignedDate>
</SignedContract>
<SignedContract>
<Content>sample string 3</Content>
<ContentId>1</ContentId>
<SectionInitials>sample string 2</SectionInitials>
<SignedDate>sample string 4</SignedDate>
</SignedContract>
</ContractContents>
<SignedContractUrl>sample string 1</SignedContractUrl>
</AdditionalInfo>
<ContractCode>sample string 6</ContractCode>
<CoupenCode>sample string 2</CoupenCode>
<DiscountApplicable>sample string 7</DiscountApplicable>
<IsTrial>true</IsTrial>
<PlanId>1</PlanId>
<PlanTypeId>Metered</PlanTypeId>
<Product>sample string 5</Product>
<ProductId>3</ProductId>
</Plan>
<ProductLoginUrl>sample string 2</ProductLoginUrl>
<ProductUrl>sample string 1</ProductUrl>
<Quotes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Quotes>
<SkipSignupEmail>true</SkipSignupEmail>
<User>
<Password>sample string 2</Password>
<UserName>sample string 1</UserName>
</User>
</SignupViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ITypedResponseOfSignupViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | SignupViewModel |
None. |
|
| Category | string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.