PUT api/collections/agencies

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Name	string	Required String length: inclusive between 3 and 100
Phone	string	Required String length: inclusive between 5 and 50
Email	string	Required String length: inclusive between 5 and 100
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedBy	integer	None.
ModifiedOn	date	None.
Address	AddressViewModel	None.
Agents	Collection of CollectionsAgentViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "phone": "sample string 3",
  "email": "sample string 4",
  "createdBy": 5,
  "createdOn": "2024-10-14T04:20:23.5938145-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T04:20:23.5938145-04:00",
  "address": {
    "addressId": 1,
    "address1": "sample string 2",
    "address2": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "zipCode": "sample string 6",
    "country": "sample string 7"
  },
  "agents": [
    {
      "id": 1,
      "contactName": "sample string 2",
      "phone": "sample string 3",
      "email": "sample string 4",
      "notes": "sample string 5",
      "createdBy": 6,
      "createdOn": "2024-10-14T04:20:23.6094201-04:00",
      "modifiedBy": 1,
      "modifiedOn": "2024-10-14T04:20:23.6094201-04:00",
      "agencyId": 8,
      "isMarkedToBeDeleted": true,
      "isLinkedToBuilding": true
    },
    {
      "id": 1,
      "contactName": "sample string 2",
      "phone": "sample string 3",
      "email": "sample string 4",
      "notes": "sample string 5",
      "createdBy": 6,
      "createdOn": "2024-10-14T04:20:23.6094201-04:00",
      "modifiedBy": 1,
      "modifiedOn": "2024-10-14T04:20:23.6094201-04:00",
      "agencyId": 8,
      "isMarkedToBeDeleted": true,
      "isLinkedToBuilding": true
    }
  ]
}

application/xml, text/xml

Sample:

<CollectionsAgencyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
    <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
    <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
    <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
    <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
    <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
    <d2p1:AddressId>1</d2p1:AddressId>
  </Address>
  <Agents>
    <CollectionsAgentViewModel>
      <AgencyId>8</AgencyId>
      <ContactName>sample string 2</ContactName>
      <CreatedBy>6</CreatedBy>
      <CreatedOn>2024-10-14T04:20:23.6094201-04:00</CreatedOn>
      <Email>sample string 4</Email>
      <Id>1</Id>
      <IsLinkedToBuilding>true</IsLinkedToBuilding>
      <IsMarkedToBeDeleted>true</IsMarkedToBeDeleted>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2024-10-14T04:20:23.6094201-04:00</ModifiedOn>
      <Notes>sample string 5</Notes>
      <Phone>sample string 3</Phone>
    </CollectionsAgentViewModel>
    <CollectionsAgentViewModel>
      <AgencyId>8</AgencyId>
      <ContactName>sample string 2</ContactName>
      <CreatedBy>6</CreatedBy>
      <CreatedOn>2024-10-14T04:20:23.6094201-04:00</CreatedOn>
      <Email>sample string 4</Email>
      <Id>1</Id>
      <IsLinkedToBuilding>true</IsLinkedToBuilding>
      <IsMarkedToBeDeleted>true</IsMarkedToBeDeleted>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2024-10-14T04:20:23.6094201-04:00</ModifiedOn>
      <Notes>sample string 5</Notes>
      <Phone>sample string 3</Phone>
    </CollectionsAgentViewModel>
  </Agents>
  <CreatedBy>5</CreatedBy>
  <CreatedOn>2024-10-14T04:20:23.5938145-04:00</CreatedOn>
  <Email>sample string 4</Email>
  <Id>1</Id>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T04:20:23.5938145-04:00</ModifiedOn>
  <Name>sample string 2</Name>
  <Phone>sample string 3</Phone>
</CollectionsAgencyViewModel>

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

Response Information

Resource Description

Collection of CollectionsAgencyViewModel

Name	Type	Additional information
Id	integer	None.
Name	string	Required String length: inclusive between 3 and 100
Phone	string	Required String length: inclusive between 5 and 50
Email	string	Required String length: inclusive between 5 and 100
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedBy	integer	None.
ModifiedOn	date	None.
Address	AddressViewModel	None.
Agents	Collection of CollectionsAgentViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "phone": "sample string 3",
    "email": "sample string 4",
    "createdBy": 5,
    "createdOn": "2024-10-14T04:20:23.625068-04:00",
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T04:20:23.625068-04:00",
    "address": {
      "addressId": 1,
      "address1": "sample string 2",
      "address2": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "zipCode": "sample string 6",
      "country": "sample string 7"
    },
    "agents": [
      {
        "id": 1,
        "contactName": "sample string 2",
        "phone": "sample string 3",
        "email": "sample string 4",
        "notes": "sample string 5",
        "createdBy": 6,
        "createdOn": "2024-10-14T04:20:23.625068-04:00",
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T04:20:23.625068-04:00",
        "agencyId": 8,
        "isMarkedToBeDeleted": true,
        "isLinkedToBuilding": true
      },
      {
        "id": 1,
        "contactName": "sample string 2",
        "phone": "sample string 3",
        "email": "sample string 4",
        "notes": "sample string 5",
        "createdBy": 6,
        "createdOn": "2024-10-14T04:20:23.625068-04:00",
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T04:20:23.625068-04:00",
        "agencyId": 8,
        "isMarkedToBeDeleted": true,
        "isLinkedToBuilding": true
      }
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "phone": "sample string 3",
    "email": "sample string 4",
    "createdBy": 5,
    "createdOn": "2024-10-14T04:20:23.625068-04:00",
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T04:20:23.625068-04:00",
    "address": {
      "addressId": 1,
      "address1": "sample string 2",
      "address2": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "zipCode": "sample string 6",
      "country": "sample string 7"
    },
    "agents": [
      {
        "id": 1,
        "contactName": "sample string 2",
        "phone": "sample string 3",
        "email": "sample string 4",
        "notes": "sample string 5",
        "createdBy": 6,
        "createdOn": "2024-10-14T04:20:23.625068-04:00",
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T04:20:23.625068-04:00",
        "agencyId": 8,
        "isMarkedToBeDeleted": true,
        "isLinkedToBuilding": true
      },
      {
        "id": 1,
        "contactName": "sample string 2",
        "phone": "sample string 3",
        "email": "sample string 4",
        "notes": "sample string 5",
        "createdBy": 6,
        "createdOn": "2024-10-14T04:20:23.625068-04:00",
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T04:20:23.625068-04:00",
        "agencyId": 8,
        "isMarkedToBeDeleted": true,
        "isLinkedToBuilding": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCollectionsAgencyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
  <CollectionsAgencyViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
      <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
      <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
      <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
      <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
      <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
      <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
      <d3p1:AddressId>1</d3p1:AddressId>
    </Address>
    <Agents>
      <CollectionsAgentViewModel>
        <AgencyId>8</AgencyId>
        <ContactName>sample string 2</ContactName>
        <CreatedBy>6</CreatedBy>
        <CreatedOn>2024-10-14T04:20:23.625068-04:00</CreatedOn>
        <Email>sample string 4</Email>
        <Id>1</Id>
        <IsLinkedToBuilding>true</IsLinkedToBuilding>
        <IsMarkedToBeDeleted>true</IsMarkedToBeDeleted>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T04:20:23.625068-04:00</ModifiedOn>
        <Notes>sample string 5</Notes>
        <Phone>sample string 3</Phone>
      </CollectionsAgentViewModel>
      <CollectionsAgentViewModel>
        <AgencyId>8</AgencyId>
        <ContactName>sample string 2</ContactName>
        <CreatedBy>6</CreatedBy>
        <CreatedOn>2024-10-14T04:20:23.625068-04:00</CreatedOn>
        <Email>sample string 4</Email>
        <Id>1</Id>
        <IsLinkedToBuilding>true</IsLinkedToBuilding>
        <IsMarkedToBeDeleted>true</IsMarkedToBeDeleted>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T04:20:23.625068-04:00</ModifiedOn>
        <Notes>sample string 5</Notes>
        <Phone>sample string 3</Phone>
      </CollectionsAgentViewModel>
    </Agents>
    <CreatedBy>5</CreatedBy>
    <CreatedOn>2024-10-14T04:20:23.625068-04:00</CreatedOn>
    <Email>sample string 4</Email>
    <Id>1</Id>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T04:20:23.625068-04:00</ModifiedOn>
    <Name>sample string 2</Name>
    <Phone>sample string 3</Phone>
  </CollectionsAgencyViewModel>
  <CollectionsAgencyViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
      <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
      <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
      <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
      <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
      <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
      <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
      <d3p1:AddressId>1</d3p1:AddressId>
    </Address>
    <Agents>
      <CollectionsAgentViewModel>
        <AgencyId>8</AgencyId>
        <ContactName>sample string 2</ContactName>
        <CreatedBy>6</CreatedBy>
        <CreatedOn>2024-10-14T04:20:23.625068-04:00</CreatedOn>
        <Email>sample string 4</Email>
        <Id>1</Id>
        <IsLinkedToBuilding>true</IsLinkedToBuilding>
        <IsMarkedToBeDeleted>true</IsMarkedToBeDeleted>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T04:20:23.625068-04:00</ModifiedOn>
        <Notes>sample string 5</Notes>
        <Phone>sample string 3</Phone>
      </CollectionsAgentViewModel>
      <CollectionsAgentViewModel>
        <AgencyId>8</AgencyId>
        <ContactName>sample string 2</ContactName>
        <CreatedBy>6</CreatedBy>
        <CreatedOn>2024-10-14T04:20:23.625068-04:00</CreatedOn>
        <Email>sample string 4</Email>
        <Id>1</Id>
        <IsLinkedToBuilding>true</IsLinkedToBuilding>
        <IsMarkedToBeDeleted>true</IsMarkedToBeDeleted>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T04:20:23.625068-04:00</ModifiedOn>
        <Notes>sample string 5</Notes>
        <Phone>sample string 3</Phone>
      </CollectionsAgentViewModel>
    </Agents>
    <CreatedBy>5</CreatedBy>
    <CreatedOn>2024-10-14T04:20:23.625068-04:00</CreatedOn>
    <Email>sample string 4</Email>
    <Id>1</Id>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T04:20:23.625068-04:00</ModifiedOn>
    <Name>sample string 2</Name>
    <Phone>sample string 3</Phone>
  </CollectionsAgencyViewModel>
</ArrayOfCollectionsAgencyViewModel>