POST public-api/addresses/customer/obsoletesave

Obsolete: This method creates/updates the addresses associated with customers. It will not create new Address Types, you will need to first create those in the web, but once you do they can be used here. Requires the Update Customer permission Accepts a maximum of 500 records at a time

Request Information

URI Parameters

None.

Body Parameters

Collection of SaveCustomerAddressRequest

Name	Description	Type	Additional information
CustomerNo	The Customer Number associated with the address.	string	None.
CustomerNumber		string	None.
FormId	Internal. This is set programmatically, any value put here will be overwritten.	WtFormId	None.
PrimaryNumber	Internal. This is set programmatically, any value put here will be overwritten.	string	None.
AddressLine1	The first line of the address.	string	None.
AddressLine2	The second line of the address.	string	None.
AddressLine3	The third line of the address.	string	None.
AddressLine4	The fourth line of the address.	string	None.
AddressCity	The city name of the address.	string	None.
AddressStateProvince	The state or province name of the address.	string	None.
AddressCountry	The country name of the address.	string	None.
AddressPostalCode	The zip/postal code.	string	None.
AddressTypeName	The type of address, these are form unique. Meaning that a customer address type does not apply to employees.	string	None.
ContactPhone	The phone number at this address. This is used only for Orders.	string	None.
ContactEmail	The email address. This is used only for Orders.	string	None.

Request Formats

application/json

Sample:

[
  {
    "CustomerNo": "sample string 3",
    "CustomerNumber": "sample string 2",
    "FormId": 0,
    "PrimaryNumber": "sample string 3",
    "AddressLine1": "sample string 4",
    "AddressLine2": "sample string 5",
    "AddressLine3": "sample string 6",
    "AddressLine4": "sample string 7",
    "AddressCity": "sample string 8",
    "AddressStateProvince": "sample string 9",
    "AddressCountry": "sample string 10",
    "AddressPostalCode": "sample string 11",
    "AddressTypeName": "sample string 12",
    "ContactPhone": "sample string 13",
    "ContactEmail": "sample string 14"
  },
  {
    "CustomerNo": "sample string 3",
    "CustomerNumber": "sample string 2",
    "FormId": 0,
    "PrimaryNumber": "sample string 3",
    "AddressLine1": "sample string 4",
    "AddressLine2": "sample string 5",
    "AddressLine3": "sample string 6",
    "AddressLine4": "sample string 7",
    "AddressCity": "sample string 8",
    "AddressStateProvince": "sample string 9",
    "AddressCountry": "sample string 10",
    "AddressPostalCode": "sample string 11",
    "AddressTypeName": "sample string 12",
    "ContactPhone": "sample string 13",
    "ContactEmail": "sample string 14"
  }
]

Response Information

Resource Description

WaspResultOfResults

Name	Description	Type	Additional information
Data	Type specific result that always depends on the function called.	Results	None.
Messages	List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages.	Collection of WtResult	None.
BatchNumber	This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party.	integer	None.
HasError	True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available.	boolean	None.
HasHttpError	True if an API function call could not be fully posted to the server or the results could not be fully returned.	boolean	None.
HasMessage	True if any message is available.	boolean	None.
HasSuccessWithMoreDataRemaining	True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time.	boolean	None.
TotalRecordsLongCount	This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster.	integer	None.

Response Formats

application/json

Sample:

{
  "Data": {
    "ResultList": [
      {
        "ResultCode": 0,
        "Message": "sample string 1",
        "HttpStatusCode": 200,
        "FieldName": "sample string 2"
      },
      {
        "ResultCode": 0,
        "Message": "sample string 1",
        "HttpStatusCode": 200,
        "FieldName": "sample string 2"
      }
    ],
    "SuccessfullResults": 1,
    "TotalResults": 2,
    "ErrorCount": 0
  },
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    },
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    }
  ],
  "BatchNumber": 1,
  "HasError": false,
  "HasHttpError": false,
  "HasMessage": true,
  "HasSuccessWithMoreDataRemaining": false,
  "TotalRecordsLongCount": 1
}