GET api/maps/geocode/{postalCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
postalCode		string	Required

Body Parameters

None.

Response Information

Resource Description

RateModel

Name	Type	Additional information
Id	integer	None.
CarrierId	integer	None.
CreationDate	date	None.
CreationUserId	integer	None.
LastModifiedDate	date	None.
LastModifiedUserId	integer	None.
TransportMode	integer	None.
TransportType	string	None.
OriginDoor	string	None.
Origin	string	None.
OriginCountry	string	None.
Destination	string	None.
DestinationCountry	string	None.
EquipmentType	string	None.
OceanRateAmt	string	None.
ExpirationDate	date	None.
Deleted	boolean	None.
AdminOnly	boolean	None.
Col_01	string	None.
Col_02	string	None.
Col_03	string	None.
Col_04	string	None.
Col_05	string	None.
Col_06	string	None.
Col_07	string	None.
Col_08	string	None.
Col_09	string	None.
Col_10	string	None.
Col_11	string	None.
Col_12	string	None.
Col_13	string	None.
Col_14	string	None.
Col_15	string	None.
Col_16	string	None.
Col_17	string	None.
Col_18	string	None.
Col_19	string	None.
Col_20	string	None.
Col_21	string	None.
Col_22	string	None.
Col_23	string	None.
Col_24	string	None.
Col_25	string	None.
Col_26	string	None.
Col_27	string	None.
Col_28	string	None.
Col_29	string	None.
Col_30	string	None.
Col_31	string	None.
Col_32	string	None.
Col_33	string	None.
Col_34	string	None.
Col_35	string	None.
Col_36	string	None.
Col_37	string	None.
Col_38	string	None.
Col_39	string	None.
Col_40	string	None.
Col_41	string	None.
Col_42	string	None.
Col_43	string	None.
Col_44	string	None.
Col_45	string	None.
Col_46	string	None.
Col_47	string	None.
Col_48	string	None.
Col_49	string	None.
Col_50	string	None.
Col_51	string	None.
Col_52	string	None.
Col_53	string	None.
Col_54	string	None.
Col_55	string	None.
Col_56	string	None.
Col_57	string	None.
Col_58	string	None.
Col_59	string	None.
Col_60	string	None.
Col_61	string	None.
Col_62	string	None.
Col_63	string	None.
Col_64	string	None.
Col_65	string	None.
Col_66	string	None.
Col_67	string	None.
Col_68	string	None.
Col_69	string	None.
Col_70	string	None.
Carrier	CarrierModel	None.
ValidationErrors	string	None.
SaveState	enuState	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CarrierId": 1,
  "CreationDate": "2025-10-14T08:14:46.6162394+00:00",
  "CreationUserId": 3,
  "LastModifiedDate": "2025-10-14T08:14:46.6162394+00:00",
  "LastModifiedUserId": 1,
  "TransportMode": 4,
  "TransportType": "sample string 5",
  "OriginDoor": "sample string 6",
  "Origin": "sample string 7",
  "OriginCountry": "sample string 8",
  "Destination": "sample string 9",
  "DestinationCountry": "sample string 10",
  "EquipmentType": "sample string 11",
  "OceanRateAmt": "sample string 12",
  "ExpirationDate": "2025-10-14T08:14:46.6162394+00:00",
  "Deleted": true,
  "AdminOnly": true,
  "Col_01": "sample string 15",
  "Col_02": "sample string 16",
  "Col_03": "sample string 17",
  "Col_04": "sample string 18",
  "Col_05": "sample string 19",
  "Col_06": "sample string 20",
  "Col_07": "sample string 21",
  "Col_08": "sample string 22",
  "Col_09": "sample string 23",
  "Col_10": "sample string 24",
  "Col_11": "sample string 25",
  "Col_12": "sample string 26",
  "Col_13": "sample string 27",
  "Col_14": "sample string 28",
  "Col_15": "sample string 29",
  "Col_16": "sample string 30",
  "Col_17": "sample string 31",
  "Col_18": "sample string 32",
  "Col_19": "sample string 33",
  "Col_20": "sample string 34",
  "Col_21": "sample string 35",
  "Col_22": "sample string 36",
  "Col_23": "sample string 37",
  "Col_24": "sample string 38",
  "Col_25": "sample string 39",
  "Col_26": "sample string 40",
  "Col_27": "sample string 41",
  "Col_28": "sample string 42",
  "Col_29": "sample string 43",
  "Col_30": "sample string 44",
  "Col_31": "sample string 45",
  "Col_32": "sample string 46",
  "Col_33": "sample string 47",
  "Col_34": "sample string 48",
  "Col_35": "sample string 49",
  "Col_36": "sample string 50",
  "Col_37": "sample string 51",
  "Col_38": "sample string 52",
  "Col_39": "sample string 53",
  "Col_40": "sample string 54",
  "Col_41": "sample string 55",
  "Col_42": "sample string 56",
  "Col_43": "sample string 57",
  "Col_44": "sample string 58",
  "Col_45": "sample string 59",
  "Col_46": "sample string 60",
  "Col_47": "sample string 61",
  "Col_48": "sample string 62",
  "Col_49": "sample string 63",
  "Col_50": "sample string 64",
  "Col_51": "sample string 65",
  "Col_52": "sample string 66",
  "Col_53": "sample string 67",
  "Col_54": "sample string 68",
  "Col_55": "sample string 69",
  "Col_56": "sample string 70",
  "Col_57": "sample string 71",
  "Col_58": "sample string 72",
  "Col_59": "sample string 73",
  "Col_60": "sample string 74",
  "Col_61": "sample string 75",
  "Col_62": "sample string 76",
  "Col_63": "sample string 77",
  "Col_64": "sample string 78",
  "Col_65": "sample string 79",
  "Col_66": "sample string 80",
  "Col_67": "sample string 81",
  "Col_68": "sample string 82",
  "Col_69": "sample string 83",
  "Col_70": "sample string 84",
  "Carrier": {
    "Id": 1,
    "AccountID": "sample string 2",
    "Name": "sample string 3",
    "Phone": "sample string 4",
    "Fax": "sample string 5",
    "Address": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "Address4": "sample string 9",
    "City": "sample string 10",
    "Apartment": "sample string 11",
    "PostalCode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "DateCreated": "2025-10-14T08:14:46.6162394+00:00",
    "ManagerId": 1,
    "Email": "sample string 16",
    "Comments": "sample string 17",
    "Status": 1,
    "StatusReason": "sample string 18",
    "Website": "sample string 19",
    "DateInsGenLiaStart": "2025-10-14T08:14:46.6162394+00:00",
    "DateInsGenLiaEnd": "2025-10-14T08:14:46.6162394+00:00",
    "DateInsCargoStart": "2025-10-14T08:14:46.6162394+00:00",
    "DateInsCargoEnd": "2025-10-14T08:14:46.6162394+00:00",
    "EmailNotif": "sample string 20",
    "GeneralLiabilityIns": 21.0,
    "CargoIns": 22.0,
    "PolicyNoGenLia": "sample string 23",
    "PolicyNoCargo": "sample string 24",
    "LastWarnEmail": "2025-10-14T08:14:46.6162394+00:00",
    "FilterType": 25,
    "StatesCovered": "sample string 26",
    "CarrierAttachment": [
      {
        "Id": 1,
        "CarrierId": 2,
        "FileName": "sample string 3",
        "FileSize": 4.1,
        "UploadDate": "2025-10-14T08:14:46.6162394+00:00",
        "FileType": "sample string 6",
        "Description": "sample string 7",
        "AttachType": 8,
        "bIsDeleted": true,
        "ValidationErrors": "sample string 10",
        "SaveState": 0
      },
      {
        "Id": 1,
        "CarrierId": 2,
        "FileName": "sample string 3",
        "FileSize": 4.1,
        "UploadDate": "2025-10-14T08:14:46.6162394+00:00",
        "FileType": "sample string 6",
        "Description": "sample string 7",
        "AttachType": 8,
        "bIsDeleted": true,
        "ValidationErrors": "sample string 10",
        "SaveState": 0
      }
    ],
    "Contact": [
      {
        "Id": 1,
        "CarrierId": 1,
        "ClientId": 1,
        "Name": "sample string 2",
        "Title": "sample string 3",
        "Phone": "sample string 4",
        "Fax": "sample string 5",
        "Mobile": "sample string 6",
        "Email": "sample string 7",
        "Notes": "sample string 8",
        "bIsDeleted": true,
        "bIsModified": true,
        "ValidationErrors": "sample string 11",
        "SaveState": 0
      },
      {
        "Id": 1,
        "CarrierId": 1,
        "ClientId": 1,
        "Name": "sample string 2",
        "Title": "sample string 3",
        "Phone": "sample string 4",
        "Fax": "sample string 5",
        "Mobile": "sample string 6",
        "Email": "sample string 7",
        "Notes": "sample string 8",
        "bIsDeleted": true,
        "bIsModified": true,
        "ValidationErrors": "sample string 11",
        "SaveState": 0
      }
    ],
    "Carrier_ServiceType": [
      {
        "Id": 1,
        "CarrierId": 2,
        "ServiceTypeId": 3,
        "ServiceType": {
          "Id": 1,
          "Name": "sample string 2",
          "NameFr": "sample string 3",
          "Description": "sample string 4",
          "DescriptionFr": "sample string 5",
          "TransportMode": 6,
          "ValidationErrors": "sample string 7",
          "SaveState": 0
        },
        "bIsDeleted": true,
        "ValidationErrors": "sample string 5",
        "SaveState": 0
      },
      {
        "Id": 1,
        "CarrierId": 2,
        "ServiceTypeId": 3,
        "ServiceType": {
          "Id": 1,
          "Name": "sample string 2",
          "NameFr": "sample string 3",
          "Description": "sample string 4",
          "DescriptionFr": "sample string 5",
          "TransportMode": 6,
          "ValidationErrors": "sample string 7",
          "SaveState": 0
        },
        "bIsDeleted": true,
        "ValidationErrors": "sample string 5",
        "SaveState": 0
      }
    ],
    "SelectedTypes": [
      1,
      2
    ],
    "ServiceTypesVal": "sample string 27",
    "sStatusDescription": "Active",
    "dDateInsGenLiaStart": "2025/10/14",
    "dDateInsGenLiaEnd": "2025/10/14",
    "dDateInsCargoStart": "2025/10/14",
    "dDateInsCargoEnd": "2025/10/14",
    "ValidationErrors": "sample string 28",
    "SaveState": 0
  },
  "ValidationErrors": "sample string 85",
  "SaveState": 0
}

application/xml, text/xml

Sample:

<RateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SaveState>Unchanged</SaveState>
  <Id>1</Id>
  <CarrierId>1</CarrierId>
  <CreationDate>2025-10-14T08:14:46.6162394+00:00</CreationDate>
  <CreationUserId>3</CreationUserId>
  <LastModifiedDate>2025-10-14T08:14:46.6162394+00:00</LastModifiedDate>
  <LastModifiedUserId>1</LastModifiedUserId>
  <TransportMode>4</TransportMode>
  <TransportType>sample string 5</TransportType>
  <OriginDoor>sample string 6</OriginDoor>
  <Origin>sample string 7</Origin>
  <OriginCountry>sample string 8</OriginCountry>
  <Destination>sample string 9</Destination>
  <DestinationCountry>sample string 10</DestinationCountry>
  <EquipmentType>sample string 11</EquipmentType>
  <OceanRateAmt>sample string 12</OceanRateAmt>
  <ExpirationDate>2025-10-14T08:14:46.6162394+00:00</ExpirationDate>
  <Deleted>true</Deleted>
  <AdminOnly>true</AdminOnly>
  <Col_01>sample string 15</Col_01>
  <Col_02>sample string 16</Col_02>
  <Col_03>sample string 17</Col_03>
  <Col_04>sample string 18</Col_04>
  <Col_05>sample string 19</Col_05>
  <Col_06>sample string 20</Col_06>
  <Col_07>sample string 21</Col_07>
  <Col_08>sample string 22</Col_08>
  <Col_09>sample string 23</Col_09>
  <Col_10>sample string 24</Col_10>
  <Col_11>sample string 25</Col_11>
  <Col_12>sample string 26</Col_12>
  <Col_13>sample string 27</Col_13>
  <Col_14>sample string 28</Col_14>
  <Col_15>sample string 29</Col_15>
  <Col_16>sample string 30</Col_16>
  <Col_17>sample string 31</Col_17>
  <Col_18>sample string 32</Col_18>
  <Col_19>sample string 33</Col_19>
  <Col_20>sample string 34</Col_20>
  <Col_21>sample string 35</Col_21>
  <Col_22>sample string 36</Col_22>
  <Col_23>sample string 37</Col_23>
  <Col_24>sample string 38</Col_24>
  <Col_25>sample string 39</Col_25>
  <Col_26>sample string 40</Col_26>
  <Col_27>sample string 41</Col_27>
  <Col_28>sample string 42</Col_28>
  <Col_29>sample string 43</Col_29>
  <Col_30>sample string 44</Col_30>
  <Col_31>sample string 45</Col_31>
  <Col_32>sample string 46</Col_32>
  <Col_33>sample string 47</Col_33>
  <Col_34>sample string 48</Col_34>
  <Col_35>sample string 49</Col_35>
  <Col_36>sample string 50</Col_36>
  <Col_37>sample string 51</Col_37>
  <Col_38>sample string 52</Col_38>
  <Col_39>sample string 53</Col_39>
  <Col_40>sample string 54</Col_40>
  <Col_41>sample string 55</Col_41>
  <Col_42>sample string 56</Col_42>
  <Col_43>sample string 57</Col_43>
  <Col_44>sample string 58</Col_44>
  <Col_45>sample string 59</Col_45>
  <Col_46>sample string 60</Col_46>
  <Col_47>sample string 61</Col_47>
  <Col_48>sample string 62</Col_48>
  <Col_49>sample string 63</Col_49>
  <Col_50>sample string 64</Col_50>
  <Col_51>sample string 65</Col_51>
  <Col_52>sample string 66</Col_52>
  <Col_53>sample string 67</Col_53>
  <Col_54>sample string 68</Col_54>
  <Col_55>sample string 69</Col_55>
  <Col_56>sample string 70</Col_56>
  <Col_57>sample string 71</Col_57>
  <Col_58>sample string 72</Col_58>
  <Col_59>sample string 73</Col_59>
  <Col_60>sample string 74</Col_60>
  <Col_61>sample string 75</Col_61>
  <Col_62>sample string 76</Col_62>
  <Col_63>sample string 77</Col_63>
  <Col_64>sample string 78</Col_64>
  <Col_65>sample string 79</Col_65>
  <Col_66>sample string 80</Col_66>
  <Col_67>sample string 81</Col_67>
  <Col_68>sample string 82</Col_68>
  <Col_69>sample string 83</Col_69>
  <Col_70>sample string 84</Col_70>
  <Carrier>
    <SaveState>Unchanged</SaveState>
    <Id>1</Id>
    <AccountID>sample string 2</AccountID>
    <Name>sample string 3</Name>
    <Phone>sample string 4</Phone>
    <Fax>sample string 5</Fax>
    <Address>sample string 6</Address>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <Address4>sample string 9</Address4>
    <City>sample string 10</City>
    <Apartment>sample string 11</Apartment>
    <PostalCode>sample string 12</PostalCode>
    <State>sample string 13</State>
    <Country>sample string 14</Country>
    <DateCreated>2025-10-14T08:14:46.6162394+00:00</DateCreated>
    <ManagerId>1</ManagerId>
    <Email>sample string 16</Email>
    <Comments>sample string 17</Comments>
    <Status>1</Status>
    <StatusReason>sample string 18</StatusReason>
    <Website>sample string 19</Website>
    <DateInsGenLiaStart>2025-10-14T08:14:46.6162394+00:00</DateInsGenLiaStart>
    <DateInsGenLiaEnd>2025-10-14T08:14:46.6162394+00:00</DateInsGenLiaEnd>
    <DateInsCargoStart>2025-10-14T08:14:46.6162394+00:00</DateInsCargoStart>
    <DateInsCargoEnd>2025-10-14T08:14:46.6162394+00:00</DateInsCargoEnd>
    <EmailNotif>sample string 20</EmailNotif>
    <GeneralLiabilityIns>21</GeneralLiabilityIns>
    <CargoIns>22</CargoIns>
    <PolicyNoGenLia>sample string 23</PolicyNoGenLia>
    <PolicyNoCargo>sample string 24</PolicyNoCargo>
    <LastWarnEmail>2025-10-14T08:14:46.6162394+00:00</LastWarnEmail>
    <FilterType>25</FilterType>
    <StatesCovered>sample string 26</StatesCovered>
    <CarrierAttachment>
      <CarrierAttachmentModel>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <CarrierId>2</CarrierId>
        <FileName>sample string 3</FileName>
        <FileSize>4.1</FileSize>
        <UploadDate>2025-10-14T08:14:46.6162394+00:00</UploadDate>
        <FileType>sample string 6</FileType>
        <Description>sample string 7</Description>
        <AttachType>8</AttachType>
        <bIsDeleted>true</bIsDeleted>
        <ValidationErrors>sample string 10</ValidationErrors>
      </CarrierAttachmentModel>
      <CarrierAttachmentModel>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <CarrierId>2</CarrierId>
        <FileName>sample string 3</FileName>
        <FileSize>4.1</FileSize>
        <UploadDate>2025-10-14T08:14:46.6162394+00:00</UploadDate>
        <FileType>sample string 6</FileType>
        <Description>sample string 7</Description>
        <AttachType>8</AttachType>
        <bIsDeleted>true</bIsDeleted>
        <ValidationErrors>sample string 10</ValidationErrors>
      </CarrierAttachmentModel>
    </CarrierAttachment>
    <Contact>
      <ContactModel>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <CarrierId>1</CarrierId>
        <ClientId>1</ClientId>
        <Name>sample string 2</Name>
        <Title>sample string 3</Title>
        <Phone>sample string 4</Phone>
        <Fax>sample string 5</Fax>
        <Mobile>sample string 6</Mobile>
        <Email>sample string 7</Email>
        <Notes>sample string 8</Notes>
        <bIsDeleted>true</bIsDeleted>
        <bIsModified>true</bIsModified>
        <ValidationErrors>sample string 11</ValidationErrors>
      </ContactModel>
      <ContactModel>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <CarrierId>1</CarrierId>
        <ClientId>1</ClientId>
        <Name>sample string 2</Name>
        <Title>sample string 3</Title>
        <Phone>sample string 4</Phone>
        <Fax>sample string 5</Fax>
        <Mobile>sample string 6</Mobile>
        <Email>sample string 7</Email>
        <Notes>sample string 8</Notes>
        <bIsDeleted>true</bIsDeleted>
        <bIsModified>true</bIsModified>
        <ValidationErrors>sample string 11</ValidationErrors>
      </ContactModel>
    </Contact>
    <Carrier_ServiceType>
      <CarrierServiceTypeModel>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <CarrierId>2</CarrierId>
        <ServiceTypeId>3</ServiceTypeId>
        <ServiceType>
          <SaveState>Unchanged</SaveState>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <NameFr>sample string 3</NameFr>
          <Description>sample string 4</Description>
          <DescriptionFr>sample string 5</DescriptionFr>
          <TransportMode>6</TransportMode>
          <ValidationErrors>sample string 7</ValidationErrors>
        </ServiceType>
        <bIsDeleted>true</bIsDeleted>
        <ValidationErrors>sample string 5</ValidationErrors>
      </CarrierServiceTypeModel>
      <CarrierServiceTypeModel>
        <SaveState>Unchanged</SaveState>
        <Id>1</Id>
        <CarrierId>2</CarrierId>
        <ServiceTypeId>3</ServiceTypeId>
        <ServiceType>
          <SaveState>Unchanged</SaveState>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <NameFr>sample string 3</NameFr>
          <Description>sample string 4</Description>
          <DescriptionFr>sample string 5</DescriptionFr>
          <TransportMode>6</TransportMode>
          <ValidationErrors>sample string 7</ValidationErrors>
        </ServiceType>
        <bIsDeleted>true</bIsDeleted>
        <ValidationErrors>sample string 5</ValidationErrors>
      </CarrierServiceTypeModel>
    </Carrier_ServiceType>
    <SelectedTypes>
      <int>1</int>
      <int>2</int>
    </SelectedTypes>
    <ServiceTypesVal>sample string 27</ServiceTypesVal>
    <ValidationErrors>sample string 28</ValidationErrors>
  </Carrier>
  <ValidationErrors>sample string 85</ValidationErrors>
</RateModel>