PATCH api/platform/providers/{providerId}/addresses/{addressId}?rqUID={rqUID}

Request Information

URI Parameters

Name	Type	Additional information
providerId	integer	Required
addressId	integer	Required
rqUID	string	None.

Body Parameters

RestAddressMixRequestDTO

Name	Type	Additional information
Address	string	String length: inclusive between 0 and 80
PostCode	string	String length: inclusive between 0 and 8
Locality	string	String length: inclusive between 0 and 50
Province	string	String length: inclusive between 0 and 20
CountryId	Country	None.
IsFiscal	boolean	None.
IsPhysical	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Address": "sample string 1",
  "PostCode": "sample string 2",
  "Locality": "sample string 3",
  "Province": "sample string 4",
  "CountryId": 1,
  "IsFiscal": true,
  "IsPhysical": true
}

application/xml, text/xml

Sample:

<RestAddressMixRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Platform">
  <Address>sample string 1</Address>
  <CountryId>SPAIN</CountryId>
  <IsFiscal>true</IsFiscal>
  <IsPhysical>true</IsPhysical>
  <Locality>sample string 3</Locality>
  <PostCode>sample string 2</PostCode>
  <Province>sample string 4</Province>
</RestAddressMixRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RestElementResponseDTOOfRestFullAddressDTO

Name	Type	Additional information
Element	RestFullAddressDTO	None.
RqUID	string	None.
Code	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Element": {
    "Id": 1,
    "CountryId": 1,
    "IsFiscal": true,
    "IsPhysical": true,
    "Address": "sample string 4",
    "PostCode": "sample string 5",
    "Locality": "sample string 6",
    "Province": "sample string 7"
  },
  "RqUID": "sample string 1",
  "Code": "sample string 2",
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:

<RestElementResponseDTOOfRestFullAddressDTOMGEbpewl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">
  <Code>sample string 2</Code>
  <Message>sample string 3</Message>
  <RqUID>sample string 1</RqUID>
  <Element xmlns:d2p1="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Platform">
    <Address>sample string 4</Address>
    <Locality>sample string 6</Locality>
    <PostCode>sample string 5</PostCode>
    <Province>sample string 7</Province>
    <d2p1:CountryId>SPAIN</d2p1:CountryId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsFiscal>true</d2p1:IsFiscal>
    <d2p1:IsPhysical>true</d2p1:IsPhysical>
  </Element>
</RestElementResponseDTOOfRestFullAddressDTOMGEbpewl>