POST api/AddressBook/AddAddressBookCustomerAssign

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BusinessId	integer	None.
LoggedinUserID	integer	None.
AssignTo	integer	None.
PreviousAgentID	integer	None.
ContactIds	string	None.
ContactId	integer	None.
Flag	integer	None.
Isretaining	integer	None.
AssignToIds	string	None.
Retainedby	string	None.
CustomerIDs	string	None.
newPlanDetails	Collection of CustomerMovePlanDetails	None.

Request Formats

application/json, text/json

Sample:

{
  "BusinessId": 1,
  "LoggedinUserID": 2,
  "AssignTo": 3,
  "PreviousAgentID": 4,
  "ContactIds": "sample string 5",
  "ContactId": 6,
  "Flag": 7,
  "Isretaining": 8,
  "AssignToIds": "sample string 9",
  "Retainedby": "sample string 10",
  "CustomerIDs": "sample string 11",
  "newPlanDetails": [
    {
      "CustomerId": 1,
      "AgentId": 2,
      "NewPlanId": 3
    },
    {
      "CustomerId": 1,
      "AgentId": 2,
      "NewPlanId": 3
    }
  ]
}

application/xml, text/xml

Sample:

<AddAddressBookCustomerAssign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <AssignTo>3</AssignTo>
  <AssignToIds>sample string 9</AssignToIds>
  <BusinessId>1</BusinessId>
  <ContactId>6</ContactId>
  <ContactIds>sample string 5</ContactIds>
  <CustomerIDs>sample string 11</CustomerIDs>
  <Flag>7</Flag>
  <Isretaining>8</Isretaining>
  <LoggedinUserID>2</LoggedinUserID>
  <PreviousAgentID>4</PreviousAgentID>
  <Retainedby>sample string 10</Retainedby>
  <newPlanDetails>
    <CustomerMovePlanDetails>
      <AgentId>2</AgentId>
      <CustomerId>1</CustomerId>
      <NewPlanId>3</NewPlanId>
    </CustomerMovePlanDetails>
    <CustomerMovePlanDetails>
      <AgentId>2</AgentId>
      <CustomerId>1</CustomerId>
      <NewPlanId>3</NewPlanId>
    </CustomerMovePlanDetails>
  </newPlanDetails>
</AddAddressBookCustomerAssign>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/04 03:38:24",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>