POST api/platform/providers?rqUID={rqUID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
rqUID | string |
None. |
Body Parameters
RestPlatformProviderCreateRequestDTOName | Description | Type | Additional information |
---|---|---|---|
Logo | RestFileDTO |
None. |
|
Id | integer |
None. |
|
Type | EntityType |
Required |
|
EntityCode | string |
String length: inclusive between 0 and 40 |
|
FirmName | string |
Required String length: inclusive between 0 and 80 |
|
CommercialName | string |
Required String length: inclusive between 0 and 80 |
|
NIF | string |
Required String length: inclusive between 0 and 30 |
|
LegalForm | LegalFormType |
Required |
|
TaxMasterId | integer |
Required |
|
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. |
|
AddressList | Collection of RestFullAddressDTO |
None. |
|
ContactList | Collection of RestFullContactDTO |
None. |
Request Formats
application/json, text/json
Sample:
{ "Logo": { "FileName": "sample string 1", "FileStream": "QEA=" }, "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-04-29", "Active": true, "ClaimsModule": true, "CountryId": 1, "GtmCode": "sample string 7", "Observations": "sample string 8", "CommercialRegisterNumber": "sample string 9", "SocialCapitalAmount": 1, "AddressList": [ { "Id": 1, "CountryId": 1, "IsFiscal": true, "IsPhysical": true, "Address": "sample string 4", "PostCode": "sample string 5", "Locality": "sample string 6", "Province": "sample string 7" }, { "Id": 1, "CountryId": 1, "IsFiscal": true, "IsPhysical": true, "Address": "sample string 4", "PostCode": "sample string 5", "Locality": "sample string 6", "Province": "sample string 7" } ], "ContactList": [ { "Id": 1, "AuthorizationsEnabled": true, "AuthorizationsMain": true, "PurchasesEnabled": true, "PurchasesMain": true, "OrdersEnabled": true, "OrdersMain": true, "ClaimsEnabled": true, "ClaimsMain": true, "Name": "sample string 10", "Phone": "sample string 11", "Mail": "sample string 12" }, { "Id": 1, "AuthorizationsEnabled": true, "AuthorizationsMain": true, "PurchasesEnabled": true, "PurchasesMain": true, "OrdersEnabled": true, "OrdersMain": true, "ClaimsEnabled": true, "ClaimsMain": true, "Name": "sample string 10", "Phone": "sample string 11", "Mail": "sample string 12" } ] }
application/xml, text/xml
Sample:
<RestPlatformProviderCreateRequestDTO 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> <AddressList> <RestFullAddressDTO> <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> <RestFullAddressDTO> <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> </AddressList> <ClaimsModule>true</ClaimsModule> <CommercialName>sample string 4</CommercialName> <CommercialRegisterNumber>sample string 9</CommercialRegisterNumber> <ContactList> <RestFullContactDTO> <Mail xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 12</Mail> <Name xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 10</Name> <Phone xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 11</Phone> <AuthorizationsEnabled>true</AuthorizationsEnabled> <AuthorizationsMain>true</AuthorizationsMain> <ClaimsEnabled>true</ClaimsEnabled> <ClaimsMain>true</ClaimsMain> <Id>1</Id> <OrdersEnabled>true</OrdersEnabled> <OrdersMain>true</OrdersMain> <PurchasesEnabled>true</PurchasesEnabled> <PurchasesMain>true</PurchasesMain> </RestFullContactDTO> <RestFullContactDTO> <Mail xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 12</Mail> <Name xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 10</Name> <Phone xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">sample string 11</Phone> <AuthorizationsEnabled>true</AuthorizationsEnabled> <AuthorizationsMain>true</AuthorizationsMain> <ClaimsEnabled>true</ClaimsEnabled> <ClaimsMain>true</ClaimsMain> <Id>1</Id> <OrdersEnabled>true</OrdersEnabled> <OrdersMain>true</OrdersMain> <PurchasesEnabled>true</PurchasesEnabled> <PurchasesMain>true</PurchasesMain> </RestFullContactDTO> </ContactList> <CountryId>SPAIN</CountryId> <EntityCode>sample string 2</EntityCode> <FirmName>sample string 3</FirmName> <GtmCode>sample string 7</GtmCode> <Id>1</Id> <LegalForm>NONE</LegalForm> <NIF>sample string 5</NIF> <Observations>sample string 8</Observations> <RegistrationDate>2025-04-29T19:13:41.6820367+02:00</RegistrationDate> <SocialCapitalAmount>1</SocialCapitalAmount> <TaxMasterId>6</TaxMasterId> <Type>COMPANY</Type> <Logo xmlns:d2p1="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared"> <d2p1:FileName>sample string 1</d2p1:FileName> <d2p1:FileStream>QEA=</d2p1:FileStream> </Logo> </RestPlatformProviderCreateRequestDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RestElementResponseDTOOfRestPlatformProviderDTOName | Description | Type | Additional information |
---|---|---|---|
Element | RestPlatformProviderDTO |
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-04-29", "Active": true, "ClaimsModule": true, "CountryId": 1, "GtmCode": "sample string 7", "Observations": "sample string 8", "CommercialRegisterNumber": "sample string 9", "SocialCapitalAmount": 1, "AddressList": [ { "Id": 1, "CountryId": 1, "IsFiscal": true, "IsPhysical": true, "Address": "sample string 4", "PostCode": "sample string 5", "Locality": "sample string 6", "Province": "sample string 7" }, { "Id": 1, "CountryId": 1, "IsFiscal": true, "IsPhysical": true, "Address": "sample string 4", "PostCode": "sample string 5", "Locality": "sample string 6", "Province": "sample string 7" } ], "ContactList": [ { "Id": 1, "AuthorizationsEnabled": true, "AuthorizationsMain": true, "PurchasesEnabled": true, "PurchasesMain": true, "OrdersEnabled": true, "OrdersMain": true, "ClaimsEnabled": true, "ClaimsMain": true, "Name": "sample string 10", "Phone": "sample string 11", "Mail": "sample string 12" }, { "Id": 1, "AuthorizationsEnabled": true, "AuthorizationsMain": true, "PurchasesEnabled": true, "PurchasesMain": true, "OrdersEnabled": true, "OrdersMain": true, "ClaimsEnabled": true, "ClaimsMain": true, "Name": "sample string 10", "Phone": "sample string 11", "Mail": "sample string 12" } ] }, "RqUID": "sample string 1", "Code": "sample string 2", "Message": "sample string 3" }
application/xml, text/xml
Sample:
<RestElementResponseDTOOfRestPlatformProviderDTOMGEbpewl 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:AddressList> <d2p1:RestFullAddressDTO> <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> </d2p1:RestFullAddressDTO> <d2p1:RestFullAddressDTO> <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> </d2p1:RestFullAddressDTO> </d2p1:AddressList> <d2p1:ClaimsModule>true</d2p1:ClaimsModule> <d2p1:CommercialName>sample string 4</d2p1:CommercialName> <d2p1:CommercialRegisterNumber>sample string 9</d2p1:CommercialRegisterNumber> <d2p1:ContactList> <d2p1:RestFullContactDTO> <Mail>sample string 12</Mail> <Name>sample string 10</Name> <Phone>sample string 11</Phone> <d2p1:AuthorizationsEnabled>true</d2p1:AuthorizationsEnabled> <d2p1:AuthorizationsMain>true</d2p1:AuthorizationsMain> <d2p1:ClaimsEnabled>true</d2p1:ClaimsEnabled> <d2p1:ClaimsMain>true</d2p1:ClaimsMain> <d2p1:Id>1</d2p1:Id> <d2p1:OrdersEnabled>true</d2p1:OrdersEnabled> <d2p1:OrdersMain>true</d2p1:OrdersMain> <d2p1:PurchasesEnabled>true</d2p1:PurchasesEnabled> <d2p1:PurchasesMain>true</d2p1:PurchasesMain> </d2p1:RestFullContactDTO> <d2p1:RestFullContactDTO> <Mail>sample string 12</Mail> <Name>sample string 10</Name> <Phone>sample string 11</Phone> <d2p1:AuthorizationsEnabled>true</d2p1:AuthorizationsEnabled> <d2p1:AuthorizationsMain>true</d2p1:AuthorizationsMain> <d2p1:ClaimsEnabled>true</d2p1:ClaimsEnabled> <d2p1:ClaimsMain>true</d2p1:ClaimsMain> <d2p1:Id>1</d2p1:Id> <d2p1:OrdersEnabled>true</d2p1:OrdersEnabled> <d2p1:OrdersMain>true</d2p1:OrdersMain> <d2p1:PurchasesEnabled>true</d2p1:PurchasesEnabled> <d2p1:PurchasesMain>true</d2p1:PurchasesMain> </d2p1:RestFullContactDTO> </d2p1:ContactList> <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-04-29T19:13:41.7129124+02:00</d2p1:RegistrationDate> <d2p1:SocialCapitalAmount>1</d2p1:SocialCapitalAmount> <d2p1:TaxMasterId>6</d2p1:TaxMasterId> <d2p1:Type>COMPANY</d2p1:Type> </Element> </RestElementResponseDTOOfRestPlatformProviderDTOMGEbpewl>