POST api/AddressGeocode?placemarkId={placemarkId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
placemarkId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
AddressResponseName | Description | Type | Additional information |
---|---|---|---|
Address | Address |
None. |
|
Success | boolean |
None. |
|
ExceptionMessage | string |
None. |
|
SuccessMessage | string |
None. |
|
IsBaseResponse | boolean |
None. |
|
NewSessionLunchcartCreated | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Address": { "AddressId": 1, "CrossStreetInstructions": "sample string 2", "IsVirtualCafe": true, "AddressHash": "sample string 4", "BuildingHash": "sample string 5", "TypeName": "sample string 6", "TypeValue": 1, "CellId": "sample string 7", "IsEcafe": true, "ParkingFlag": 9, "ContactFirstName": "sample string 10", "FriendlyAddress": "sample string 11", "FriendlyAddressHtml": "sample string 12", "FriendlyContactDisplay": "sample string 13", "ContactLastName": "sample string 14", "ContactPhone": "sample string 15", "ContactPhoneExt": "sample string 16", "ContactEmail": "sample string 17", "ContactCompany": "sample string 18", "StreetAddress": "sample string 19", "City": "sample string 20", "State": "sample string 21", "Zip": "sample string 22", "ZipExtendedFour": "sample string 23", "Suite": "sample string 24", "Floor": "sample string 25", "Telephone": "sample string 26", "TelephoneExt": "sample string 27", "LinkedCC": true, "LinkedTermAccount": true, "Favorite": true, "BuildingActive": true, "AddressActive": true, "PriorityPickupStatus": 33, "ValidationResponse": true, "ValidationResponseMessage": "sample string 35", "IsLunchStop": true, "LunchStopId": 37, "LunchStopName": "sample string 38", "LunchStopStatus": 39, "IsLocked": true, "IsPickupLocation": true, "IsCustomerDefaultLocation": true }, "Success": true, "ExceptionMessage": "sample string 2", "SuccessMessage": "sample string 3", "IsBaseResponse": true, "NewSessionLunchcartCreated": true }
text/html
Sample:
{"Address":{"AddressId":1,"CrossStreetInstructions":"sample string 2","IsVirtualCafe":true,"AddressHash":"sample string 4","BuildingHash":"sample string 5","TypeName":"sample string 6","TypeValue":1,"CellId":"sample string 7","IsEcafe":true,"ParkingFlag":9,"ContactFirstName":"sample string 10","FriendlyAddress":"sample string 11","FriendlyAddressHtml":"sample string 12","FriendlyContactDisplay":"sample string 13","ContactLastName":"sample string 14","ContactPhone":"sample string 15","ContactPhoneExt":"sample string 16","ContactEmail":"sample string 17","ContactCompany":"sample string 18","StreetAddress":"sample string 19","City":"sample string 20","State":"sample string 21","Zip":"sample string 22","ZipExtendedFour":"sample string 23","Suite":"sample string 24","Floor":"sample string 25","Telephone":"sample string 26","TelephoneExt":"sample string 27","LinkedCC":true,"LinkedTermAccount":true,"Favorite":true,"BuildingActive":true,"AddressActive":true,"PriorityPickupStatus":33,"ValidationResponse":true,"ValidationResponseMessage":"sample string 35","IsLunchStop":true,"LunchStopId":37,"LunchStopName":"sample string 38","LunchStopStatus":39,"IsLocked":true,"IsPickupLocation":true,"IsCustomerDefaultLocation":true},"Success":true,"ExceptionMessage":"sample string 2","SuccessMessage":"sample string 3","IsBaseResponse":true,"NewSessionLunchcartCreated":true}
application/xml, text/xml
Sample:
<AddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Specialtys.DTO.Response"> <ExceptionMessage>sample string 2</ExceptionMessage> <IsBaseResponse>true</IsBaseResponse> <NewSessionLunchcartCreated>true</NewSessionLunchcartCreated> <Success>true</Success> <SuccessMessage>sample string 3</SuccessMessage> <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Specialtys.DTO"> <d2p1:AddressActive>true</d2p1:AddressActive> <d2p1:AddressHash>sample string 4</d2p1:AddressHash> <d2p1:AddressId>1</d2p1:AddressId> <d2p1:BuildingActive>true</d2p1:BuildingActive> <d2p1:BuildingHash>sample string 5</d2p1:BuildingHash> <d2p1:CellId>sample string 7</d2p1:CellId> <d2p1:City>sample string 20</d2p1:City> <d2p1:ContactCompany>sample string 18</d2p1:ContactCompany> <d2p1:ContactEmail>sample string 17</d2p1:ContactEmail> <d2p1:ContactFirstName>sample string 10</d2p1:ContactFirstName> <d2p1:ContactLastName>sample string 14</d2p1:ContactLastName> <d2p1:ContactPhone>sample string 15</d2p1:ContactPhone> <d2p1:ContactPhoneExt>sample string 16</d2p1:ContactPhoneExt> <d2p1:CrossStreetInstructions>sample string 2</d2p1:CrossStreetInstructions> <d2p1:Favorite>true</d2p1:Favorite> <d2p1:Floor>sample string 25</d2p1:Floor> <d2p1:FriendlyAddress>sample string 11</d2p1:FriendlyAddress> <d2p1:FriendlyAddressHtml>sample string 12</d2p1:FriendlyAddressHtml> <d2p1:FriendlyContactDisplay>sample string 13</d2p1:FriendlyContactDisplay> <d2p1:IsCustomerDefaultLocation>true</d2p1:IsCustomerDefaultLocation> <d2p1:IsEcafe>true</d2p1:IsEcafe> <d2p1:IsLocked>true</d2p1:IsLocked> <d2p1:IsLunchStop>true</d2p1:IsLunchStop> <d2p1:IsPickupLocation>true</d2p1:IsPickupLocation> <d2p1:IsVirtualCafe>true</d2p1:IsVirtualCafe> <d2p1:LinkedCC>true</d2p1:LinkedCC> <d2p1:LinkedTermAccount>true</d2p1:LinkedTermAccount> <d2p1:LunchStopId>37</d2p1:LunchStopId> <d2p1:LunchStopName>sample string 38</d2p1:LunchStopName> <d2p1:LunchStopStatus>39</d2p1:LunchStopStatus> <d2p1:ParkingFlag>9</d2p1:ParkingFlag> <d2p1:PriorityPickupStatus>33</d2p1:PriorityPickupStatus> <d2p1:State>sample string 21</d2p1:State> <d2p1:StreetAddress>sample string 19</d2p1:StreetAddress> <d2p1:Suite>sample string 24</d2p1:Suite> <d2p1:Telephone>sample string 26</d2p1:Telephone> <d2p1:TelephoneExt>sample string 27</d2p1:TelephoneExt> <d2p1:TypeName>sample string 6</d2p1:TypeName> <d2p1:TypeValue>1</d2p1:TypeValue> <d2p1:ValidationResponse>true</d2p1:ValidationResponse> <d2p1:ValidationResponseMessage>sample string 35</d2p1:ValidationResponseMessage> <d2p1:Zip>sample string 22</d2p1:Zip> <d2p1:ZipExtendedFour>sample string 23</d2p1:ZipExtendedFour> </Address> </AddressResponse>