POST Party/Add

Request Information

URI Parameters

None.

Body Parameters

PartyViewModel
NameDescriptionTypeAdditional information
PartyId

integer

None.

PartyCode

string

None.

PartyName

string

Required

Address1

string

Required

Address2

string

None.

StateId

integer

Required

State

string

None.

StateList

Collection of Object

None.

CityId

integer

Required

City

string

None.

CityList

Collection of Object

None.

PinCode

string

None.

Email

string

Required

Matching regular expression pattern: ^[A-Za-z0-9_\+-]+(\.[A-Za-z0-9_\+-]+)*@[A-Za-z0-9-]+(\.[A-Za-z0-9-]+)*\.([A-Za-z]{2,4})$

String length: inclusive between 0 and 200

Mobile1

string

Required

Mobile2

string

None.

RegistrationTypeId

integer

Required

GSTNo

string

Matching regular expression pattern: \d{2}[A-Za-z]{5}\d{4}[A-Za-z]{1}[A-Za-z\d]{1}[Zz]{1}[A-Za-z\d]{1}

RegistrationType

string

None.

RegistrationTypeList

Collection of Object

None.

LocationTypeId

integer

Required

LocationType

string

None.

LocationTypeList

Collection of Object

None.

PANNo

string

Matching regular expression pattern: ^([a-zA-Z]){5}([0-9]){4}([a-zA-Z]){1}?$

BillingTypeId

integer

Required

BillingType

string

None.

BillingTypeList

Collection of Object

None.

IsActive

boolean

None.

Active

string

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

ModuleName

CommonMessagesViewModel

None.

IListParty

Collection of PartyViewModel

None.

ListPriceLocationIds

Collection of integer

None.

StrPriceLocationIds

string

None.

ListLocationPriceList

Collection of PartyPriceViewModel

None.

ListPartyPriceList

Collection of PartyPriceViewModel

None.

PriceExists

boolean

None.

ModifiedDate

date

None.

Success

boolean

None.

Message

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PartyId": 2,
  "PartyCode": null,
  "PartyName": "Kalyan Jewellers",
  "Address1": "Pedak road",
  "Address2": "Opp. Big Bazar",
  "StateId": 0,
  "State": "Gujarat",
  "StateList": null,
  "CityId": 0,
  "City": "Ahmedabad",
  "CityList": null,
  "PinCode": "360370",
  "Email": null,
  "Mobile1": null,
  "Mobile2": null,
  "RegistrationTypeId": 0,
  "GSTNo": "GSTE2323232",
  "RegistrationType": null,
  "RegistrationTypeList": null,
  "LocationTypeId": 5,
  "LocationType": null,
  "LocationTypeList": null,
  "PANNo": "GRDTT232323",
  "BillingTypeId": 0,
  "BillingType": null,
  "BillingTypeList": null,
  "IsActive": false,
  "Active": null,
  "CreatedBy": 0,
  "UpdatedBy": 0,
  "ModuleName": null,
  "IListParty": null,
  "ListPriceLocationIds": null,
  "StrPriceLocationIds": null,
  "ListLocationPriceList": null,
  "ListPartyPriceList": null,
  "PriceExists": false,
  "ModifiedDate": null,
  "Success": false,
  "Message": null
}

application/xml, text/xml

Sample:
<PartyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ThreeStar.Common.Models">
  <Message i:nil="true" />
  <Success>false</Success>
  <Active i:nil="true" />
  <Address1>Pedak road</Address1>
  <Address2>Opp. Big Bazar</Address2>
  <BillingType i:nil="true" />
  <BillingTypeId>0</BillingTypeId>
  <BillingTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc" i:nil="true" />
  <City>Ahmedabad</City>
  <CityId>0</CityId>
  <CityList xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc" i:nil="true" />
  <CreatedBy>0</CreatedBy>
  <Email i:nil="true" />
  <GSTNo>GSTE2323232</GSTNo>
  <IListParty i:nil="true" />
  <IsActive>false</IsActive>
  <ListLocationPriceList i:nil="true" />
  <ListPartyPriceList i:nil="true" />
  <ListPriceLocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <LocationType i:nil="true" />
  <LocationTypeId>5</LocationTypeId>
  <LocationTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc" i:nil="true" />
  <Mobile1 i:nil="true" />
  <Mobile2 i:nil="true" />
  <ModifiedDate i:nil="true" />
  <ModuleName i:nil="true" />
  <PANNo>GRDTT232323</PANNo>
  <PartyCode i:nil="true" />
  <PartyId>2</PartyId>
  <PartyName>Kalyan Jewellers</PartyName>
  <PinCode>360370</PinCode>
  <PriceExists>false</PriceExists>
  <RegistrationType i:nil="true" />
  <RegistrationTypeId>0</RegistrationTypeId>
  <RegistrationTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc" i:nil="true" />
  <State>Gujarat</State>
  <StateId>0</StateId>
  <StateList xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc" i:nil="true" />
  <StrPriceLocationIds i:nil="true" />
  <UpdatedBy>0</UpdatedBy>
</PartyViewModel>

Response Information

Resource Description

PartyResponseModel
NameDescriptionTypeAdditional information
Id

integer

None.

Ids

Collection of integer

None.

Success

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 4,
  "Ids": [],
  "Success": true,
  "Message": "Party added successfully."
}

application/xml, text/xml

Sample:
<PartyResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ThreeStar.Common.Models">
  <Message>Party added successfully.</Message>
  <Success>true</Success>
  <Id>4</Id>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
</PartyResponseModel>