PUT api/collections/agents

Insert CollectionsAgent

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AgentId	integer	None.
ContactName	string	Required String length: inclusive between 3 and 200
Phone	string	Required String length: inclusive between 5 and 50
Email	string	Required String length: inclusive between 5 and 50
Notes	string	String length: inclusive between 0 and 300
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedBy	integer	None.
ModifiedOn	date	None.
AgencyId	integer	None.
AgencyName	string	Required String length: inclusive between 3 and 100
AgencyPhone	string	Required String length: inclusive between 5 and 50
AgencyEmail	string	Required String length: inclusive between 5 and 100
AddressId	integer	None.
Address1	string	Required String length: inclusive between 3 and 50
Address2	string	String length: inclusive between 0 and 50
City	string	Required String length: inclusive between 3 and 50
State	string	Required String length: inclusive between 2 and 50
ZipCode	string	Required String length: inclusive between 5 and 50
Country	string	String length: inclusive between 0 and 50
AddressTypeId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "agentId": 1,
  "contactName": "sample string 2",
  "phone": "sample string 3",
  "email": "sample string 4",
  "notes": "sample string 5",
  "createdBy": 6,
  "createdOn": "2024-10-14T08:25:27.1179572-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T08:25:27.1179572-04:00",
  "agencyId": 8,
  "agencyName": "sample string 9",
  "agencyPhone": "sample string 10",
  "agencyEmail": "sample string 11",
  "addressId": 12,
  "address1": "sample string 13",
  "address2": "sample string 14",
  "city": "sample string 15",
  "state": "sample string 16",
  "zipCode": "sample string 17",
  "country": "sample string 18",
  "addressTypeId": 19
}

application/xml, text/xml

Sample:

<DetailedCollectionsAgentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
  <Address1>sample string 13</Address1>
  <Address2>sample string 14</Address2>
  <AddressId>12</AddressId>
  <AddressTypeId>19</AddressTypeId>
  <AgencyEmail>sample string 11</AgencyEmail>
  <AgencyId>8</AgencyId>
  <AgencyName>sample string 9</AgencyName>
  <AgencyPhone>sample string 10</AgencyPhone>
  <AgentId>1</AgentId>
  <City>sample string 15</City>
  <ContactName>sample string 2</ContactName>
  <Country>sample string 18</Country>
  <CreatedBy>6</CreatedBy>
  <CreatedOn>2024-10-14T08:25:27.1179572-04:00</CreatedOn>
  <Email>sample string 4</Email>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:25:27.1179572-04:00</ModifiedOn>
  <Notes>sample string 5</Notes>
  <Phone>sample string 3</Phone>
  <State>sample string 16</State>
  <ZipCode>sample string 17</ZipCode>
</DetailedCollectionsAgentViewModel>

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 'DetailedCollectionsAgentViewModel'.

Response Information

Resource Description

DetailedCollectionsAgentViewModel

Name	Type	Additional information
AgentId	integer	None.
ContactName	string	Required String length: inclusive between 3 and 200
Phone	string	Required String length: inclusive between 5 and 50
Email	string	Required String length: inclusive between 5 and 50
Notes	string	String length: inclusive between 0 and 300
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedBy	integer	None.
ModifiedOn	date	None.
AgencyId	integer	None.
AgencyName	string	Required String length: inclusive between 3 and 100
AgencyPhone	string	Required String length: inclusive between 5 and 50
AgencyEmail	string	Required String length: inclusive between 5 and 100
AddressId	integer	None.
Address1	string	Required String length: inclusive between 3 and 50
Address2	string	String length: inclusive between 0 and 50
City	string	Required String length: inclusive between 3 and 50
State	string	Required String length: inclusive between 2 and 50
ZipCode	string	Required String length: inclusive between 5 and 50
Country	string	String length: inclusive between 0 and 50
AddressTypeId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "agentId": 1,
  "contactName": "sample string 2",
  "phone": "sample string 3",
  "email": "sample string 4",
  "notes": "sample string 5",
  "createdBy": 6,
  "createdOn": "2024-10-14T08:25:27.1179572-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T08:25:27.1179572-04:00",
  "agencyId": 8,
  "agencyName": "sample string 9",
  "agencyPhone": "sample string 10",
  "agencyEmail": "sample string 11",
  "addressId": 12,
  "address1": "sample string 13",
  "address2": "sample string 14",
  "city": "sample string 15",
  "state": "sample string 16",
  "zipCode": "sample string 17",
  "country": "sample string 18",
  "addressTypeId": 19
}

application/xml, text/xml

Sample:

<DetailedCollectionsAgentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
  <Address1>sample string 13</Address1>
  <Address2>sample string 14</Address2>
  <AddressId>12</AddressId>
  <AddressTypeId>19</AddressTypeId>
  <AgencyEmail>sample string 11</AgencyEmail>
  <AgencyId>8</AgencyId>
  <AgencyName>sample string 9</AgencyName>
  <AgencyPhone>sample string 10</AgencyPhone>
  <AgentId>1</AgentId>
  <City>sample string 15</City>
  <ContactName>sample string 2</ContactName>
  <Country>sample string 18</Country>
  <CreatedBy>6</CreatedBy>
  <CreatedOn>2024-10-14T08:25:27.1179572-04:00</CreatedOn>
  <Email>sample string 4</Email>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:25:27.1179572-04:00</ModifiedOn>
  <Notes>sample string 5</Notes>
  <Phone>sample string 3</Phone>
  <State>sample string 16</State>
  <ZipCode>sample string 17</ZipCode>
</DetailedCollectionsAgentViewModel>