POST api/platform/providers/{providerId}/addresses?rqUID={rqUID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| providerId | integer |
Required |
|
| rqUID | string |
None. |
Body Parameters
RestFullAddressDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| CountryId | Country |
Required |
|
| IsFiscal | boolean |
None. |
|
| IsPhysical | boolean |
None. |
|
| Address | string |
Required String length: inclusive between 0 and 80 |
|
| PostCode | string |
Required String length: inclusive between 0 and 8 |
|
| Locality | string |
Required String length: inclusive between 0 and 50 |
|
| Province | string |
String length: inclusive between 0 and 20 |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"CountryId": 1,
"IsFiscal": true,
"IsPhysical": true,
"Address": "sample string 4",
"PostCode": "sample string 5",
"Locality": "sample string 6",
"Province": "sample string 7"
}
application/xml, text/xml
Sample:
<RestFullAddressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Platform"> <Address xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 4</Address> <Locality xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 6</Locality> <PostCode xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 5</PostCode> <Province xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 7</Province> <CountryId>SPAIN</CountryId> <Id>1</Id> <IsFiscal>true</IsFiscal> <IsPhysical>true</IsPhysical> </RestFullAddressDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RestElementResponseDTOOfRestFullAddressDTO| Name | Description | 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>