POST api/data/sector

Imports sectors data.

Request Information

URI Parameters

None.

Body Parameters

The model of the sector data to import.

Collection of SectorImportModel

Name	Type	Additional information
Id	integer	None.
Name	string	None.
DepotName	string	None.
CentrePointLong	decimal number	None.
CentrePointLat	decimal number	None.
DepotId	integer	None.
HouseholdCount	integer	None.
Polygons	Collection of PolygonDto	None.
SectorProperties	Collection of SectorPropertyDto	None.
HouseholdCounts	Collection of SectorHouseholdCountDto	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "DepotName": "sample string 3",
    "CentrePointLong": 1.1,
    "CentrePointLat": 1.1,
    "DepotId": 1,
    "HouseholdCount": 4,
    "Polygons": [
      {
        "Id": 1,
        "SectorId": 2,
        "ShapeId": 3,
        "Coordinates": [
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          },
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          }
        ]
      },
      {
        "Id": 1,
        "SectorId": 2,
        "ShapeId": 3,
        "Coordinates": [
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          },
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          }
        ]
      }
    ],
    "SectorProperties": [
      {
        "Id": "bf817f51-55fb-4871-8073-e8ece259d7f8",
        "SectorId": 2,
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Id": "bf817f51-55fb-4871-8073-e8ece259d7f8",
        "SectorId": 2,
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "HouseholdCounts": [
      {
        "Id": "9d937f13-3079-403e-a650-629ca28c1628",
        "SectorId": 2,
        "FamilyType": 1,
        "IncomeBracket": 1,
        "HouseholdCount": 3
      },
      {
        "Id": "9d937f13-3079-403e-a650-629ca28c1628",
        "SectorId": 2,
        "FamilyType": 1,
        "IncomeBracket": 1,
        "HouseholdCount": 3
      }
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "DepotName": "sample string 3",
    "CentrePointLong": 1.1,
    "CentrePointLat": 1.1,
    "DepotId": 1,
    "HouseholdCount": 4,
    "Polygons": [
      {
        "Id": 1,
        "SectorId": 2,
        "ShapeId": 3,
        "Coordinates": [
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          },
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          }
        ]
      },
      {
        "Id": 1,
        "SectorId": 2,
        "ShapeId": 3,
        "Coordinates": [
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          },
          {
            "Id": 1,
            "PolygonId": 2,
            "PointId": 3,
            "ShapeId": 4,
            "Lat": 5.1,
            "Long": 6.1
          }
        ]
      }
    ],
    "SectorProperties": [
      {
        "Id": "bf817f51-55fb-4871-8073-e8ece259d7f8",
        "SectorId": 2,
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Id": "bf817f51-55fb-4871-8073-e8ece259d7f8",
        "SectorId": 2,
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "HouseholdCounts": [
      {
        "Id": "9d937f13-3079-403e-a650-629ca28c1628",
        "SectorId": 2,
        "FamilyType": 1,
        "IncomeBracket": 1,
        "HouseholdCount": 3
      },
      {
        "Id": "9d937f13-3079-403e-a650-629ca28c1628",
        "SectorId": 2,
        "FamilyType": 1,
        "IncomeBracket": 1,
        "HouseholdCount": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSectorImportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models.DataImportModels">
  <SectorImportModel>
    <CentrePointLat>1.1</CentrePointLat>
    <CentrePointLong>1.1</CentrePointLong>
    <DepotId>1</DepotId>
    <DepotName>sample string 3</DepotName>
    <HouseholdCount>4</HouseholdCount>
    <HouseholdCounts xmlns:d3p1="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
      <d3p1:SectorHouseholdCountDto>
        <d3p1:FamilyType>Fledglings</d3p1:FamilyType>
        <d3p1:HouseholdCount>3</d3p1:HouseholdCount>
        <d3p1:Id>9d937f13-3079-403e-a650-629ca28c1628</d3p1:Id>
        <d3p1:IncomeBracket>Low</d3p1:IncomeBracket>
        <d3p1:SectorId>2</d3p1:SectorId>
      </d3p1:SectorHouseholdCountDto>
      <d3p1:SectorHouseholdCountDto>
        <d3p1:FamilyType>Fledglings</d3p1:FamilyType>
        <d3p1:HouseholdCount>3</d3p1:HouseholdCount>
        <d3p1:Id>9d937f13-3079-403e-a650-629ca28c1628</d3p1:Id>
        <d3p1:IncomeBracket>Low</d3p1:IncomeBracket>
        <d3p1:SectorId>2</d3p1:SectorId>
      </d3p1:SectorHouseholdCountDto>
    </HouseholdCounts>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Polygons xmlns:d3p1="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
      <d3p1:PolygonDto>
        <d3p1:Coordinates>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
        </d3p1:Coordinates>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:ShapeId>3</d3p1:ShapeId>
      </d3p1:PolygonDto>
      <d3p1:PolygonDto>
        <d3p1:Coordinates>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
        </d3p1:Coordinates>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:ShapeId>3</d3p1:ShapeId>
      </d3p1:PolygonDto>
    </Polygons>
    <SectorProperties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
      <d3p1:SectorPropertyDto>
        <d3p1:Id>bf817f51-55fb-4871-8073-e8ece259d7f8</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:SectorPropertyDto>
      <d3p1:SectorPropertyDto>
        <d3p1:Id>bf817f51-55fb-4871-8073-e8ece259d7f8</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:SectorPropertyDto>
    </SectorProperties>
  </SectorImportModel>
  <SectorImportModel>
    <CentrePointLat>1.1</CentrePointLat>
    <CentrePointLong>1.1</CentrePointLong>
    <DepotId>1</DepotId>
    <DepotName>sample string 3</DepotName>
    <HouseholdCount>4</HouseholdCount>
    <HouseholdCounts xmlns:d3p1="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
      <d3p1:SectorHouseholdCountDto>
        <d3p1:FamilyType>Fledglings</d3p1:FamilyType>
        <d3p1:HouseholdCount>3</d3p1:HouseholdCount>
        <d3p1:Id>9d937f13-3079-403e-a650-629ca28c1628</d3p1:Id>
        <d3p1:IncomeBracket>Low</d3p1:IncomeBracket>
        <d3p1:SectorId>2</d3p1:SectorId>
      </d3p1:SectorHouseholdCountDto>
      <d3p1:SectorHouseholdCountDto>
        <d3p1:FamilyType>Fledglings</d3p1:FamilyType>
        <d3p1:HouseholdCount>3</d3p1:HouseholdCount>
        <d3p1:Id>9d937f13-3079-403e-a650-629ca28c1628</d3p1:Id>
        <d3p1:IncomeBracket>Low</d3p1:IncomeBracket>
        <d3p1:SectorId>2</d3p1:SectorId>
      </d3p1:SectorHouseholdCountDto>
    </HouseholdCounts>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Polygons xmlns:d3p1="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
      <d3p1:PolygonDto>
        <d3p1:Coordinates>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
        </d3p1:Coordinates>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:ShapeId>3</d3p1:ShapeId>
      </d3p1:PolygonDto>
      <d3p1:PolygonDto>
        <d3p1:Coordinates>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
          <d3p1:PolygonCoordinateDto>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Lat>5.1</d3p1:Lat>
            <d3p1:Long>6.1</d3p1:Long>
            <d3p1:PointId>3</d3p1:PointId>
            <d3p1:PolygonId>2</d3p1:PolygonId>
            <d3p1:ShapeId>4</d3p1:ShapeId>
          </d3p1:PolygonCoordinateDto>
        </d3p1:Coordinates>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:ShapeId>3</d3p1:ShapeId>
      </d3p1:PolygonDto>
    </Polygons>
    <SectorProperties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
      <d3p1:SectorPropertyDto>
        <d3p1:Id>bf817f51-55fb-4871-8073-e8ece259d7f8</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:SectorPropertyDto>
      <d3p1:SectorPropertyDto>
        <d3p1:Id>bf817f51-55fb-4871-8073-e8ece259d7f8</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:SectorId>2</d3p1:SectorId>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:SectorPropertyDto>
    </SectorProperties>
  </SectorImportModel>
</ArrayOfSectorImportModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.