Update an address

patch

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses/{ServiceAddressId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Address Line 1
    Maximum Length: 240
    The first address line of the service address.
  • Title: Address Line 2
    Maximum Length: 240
    The second address line of the service address.
  • Title: Address Line 3
    Maximum Length: 240
    The third address line of the service address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address line of the service address.
  • Title: Address Source Code
    Maximum Length: 30
    Indicates the source of the service address of the service request. For example, the address source can be account or contact.
  • Title: City
    Maximum Length: 60
    The city of the service address.
  • Title: Country
    Maximum Length: 2
    The country of the service address.
  • Title: County
    Maximum Length: 60
    The county of the service address.
  • Title: Location ID
    The location that was the source of the service address.
  • Title: Party Site ID
    The customer address that was the source of the service address.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the service address.
  • Title: Province
    Maximum Length: 60
    The province of the service address.
  • Title: Service Address ID
    The unique identifier of the service address record.
  • Title: Service Request ID
    The unique identifier of the service request associated to the service address.
  • Title: State
    Maximum Length: 60
    The state of the service address.
  • Title: Time Zone
    Maximum Length: 50
    The time zone of the service address.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : serviceRequests-addresses-item-response
Type: object
Show Source
Back to Top