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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

integer

Required

rqUID

string

None.

Body Parameters

RestPlatformProviderMixRequestDTO
NameDescriptionTypeAdditional information
EntityCode

string

String length: inclusive between 0 and 40

FirmName

string

String length: inclusive between 0 and 80

CommercialName

string

String length: inclusive between 0 and 80

NIF

string

String length: inclusive between 0 and 30

LegalForm

LegalFormType

None.

TaxMasterId

integer

None.

RegistrationDate

date

None.

Active

boolean

None.

ClaimsModule

boolean

None.

CountryId

Country

None.

GtmCode

string

String length: inclusive between 0 and 255

Observations

string

String length: inclusive between 0 and 250

CommercialRegisterNumber

string

String length: inclusive between 0 and 20

SocialCapitalAmount

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "EntityCode": "sample string 1",
  "FirmName": "sample string 2",
  "CommercialName": "sample string 3",
  "NIF": "sample string 4",
  "LegalForm": 0,
  "TaxMasterId": 1,
  "RegistrationDate": "2025-06-27",
  "Active": true,
  "ClaimsModule": true,
  "CountryId": 1,
  "GtmCode": "sample string 5",
  "Observations": "sample string 6",
  "CommercialRegisterNumber": "sample string 7",
  "SocialCapitalAmount": 1
}

application/xml, text/xml

Sample:
<RestPlatformProviderMixRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Platform">
  <Active>true</Active>
  <ClaimsModule>true</ClaimsModule>
  <CommercialName>sample string 3</CommercialName>
  <CommercialRegisterNumber>sample string 7</CommercialRegisterNumber>
  <CountryId>SPAIN</CountryId>
  <EntityCode>sample string 1</EntityCode>
  <FirmName>sample string 2</FirmName>
  <GtmCode>sample string 5</GtmCode>
  <LegalForm>NONE</LegalForm>
  <NIF>sample string 4</NIF>
  <Observations>sample string 6</Observations>
  <RegistrationDate>2025-06-27T15:45:30.7033642+02:00</RegistrationDate>
  <SocialCapitalAmount>1</SocialCapitalAmount>
  <TaxMasterId>1</TaxMasterId>
</RestPlatformProviderMixRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RestElementResponseDTOOfRestPlatformProviderPartialDTO
NameDescriptionTypeAdditional information
Element

RestPlatformProviderPartialDTO

None.

RqUID

string

None.

Code

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Element": {
    "Id": 1,
    "Type": 1,
    "EntityCode": "sample string 2",
    "FirmName": "sample string 3",
    "CommercialName": "sample string 4",
    "NIF": "sample string 5",
    "LegalForm": 0,
    "TaxMasterId": 6,
    "RegistrationDate": "2025-06-27",
    "Active": true,
    "ClaimsModule": true,
    "CountryId": 1,
    "GtmCode": "sample string 7",
    "Observations": "sample string 8",
    "CommercialRegisterNumber": "sample string 9",
    "SocialCapitalAmount": 1
  },
  "RqUID": "sample string 1",
  "Code": "sample string 2",
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<RestElementResponseDTOOfRestPlatformProviderPartialDTOMGEbpewl 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">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:ClaimsModule>true</d2p1:ClaimsModule>
    <d2p1:CommercialName>sample string 4</d2p1:CommercialName>
    <d2p1:CommercialRegisterNumber>sample string 9</d2p1:CommercialRegisterNumber>
    <d2p1:CountryId>SPAIN</d2p1:CountryId>
    <d2p1:EntityCode>sample string 2</d2p1:EntityCode>
    <d2p1:FirmName>sample string 3</d2p1:FirmName>
    <d2p1:GtmCode>sample string 7</d2p1:GtmCode>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:LegalForm>NONE</d2p1:LegalForm>
    <d2p1:NIF>sample string 5</d2p1:NIF>
    <d2p1:Observations>sample string 8</d2p1:Observations>
    <d2p1:RegistrationDate>2025-06-27T15:45:30.7062904+02:00</d2p1:RegistrationDate>
    <d2p1:SocialCapitalAmount>1</d2p1:SocialCapitalAmount>
    <d2p1:TaxMasterId>6</d2p1:TaxMasterId>
    <d2p1:Type>COMPANY</d2p1:Type>
  </Element>
</RestElementResponseDTOOfRestPlatformProviderPartialDTOMGEbpewl>