CLIENTS v1.0
GET api/v1.0/{tenant}/clients/{idclient}?update={update}
Read the client information
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| idclient |
Client id |
integer |
Required |
| update | boolean |
Default value is False |
|
| version |
The requested API version |
string |
Required Default value is 1.0 |
| tenant | string |
None. |
Body Parameters
None.
Response Information
Resource Description
The client informations
APIReturnModelOfClientModel| Name | Description | Type | Additional information |
|---|---|---|---|
| data | ClientModel |
None. |
|
| state |
Etat de la réponse |
string |
None. |
| operation |
Type de la réponse |
string |
None. |
| result |
Résultat de la réponse |
Result |
None. |
| link |
Url du lien |
string |
None. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"data": {
"id": 1,
"numero": "sample string 2",
"type": "sample string 3",
"civilite": "sample string 4",
"formeJuridique": "sample string 5",
"nom": "sample string 6",
"nomCpl": "sample string 7",
"adCpl": "sample string 8",
"ad1": "sample string 9",
"ad2": "sample string 10",
"cp": "sample string 11",
"insee": "sample string 12",
"ville": "sample string 13",
"CantonINSEE": "sample string 14",
"pays": "sample string 15",
"regimeTVA": "sample string 16",
"hasTvaIntra": true,
"TvaIntra": "sample string 18",
"SIRET": "sample string 19",
"NAF": "sample string 20",
"tel": "sample string 21",
"port": "sample string 22",
"email": "sample string 23",
"param1": {
"id": 1,
"paramName": "sample string 2",
"code": "sample string 3",
"lib": "sample string 4"
},
"param2": {
"id": 1,
"paramName": "sample string 2",
"code": "sample string 3",
"lib": "sample string 4"
},
"activities": null,
"features": null,
"orders": null,
"subscriptions": null,
"memberships": null,
"invoices": null,
"payments": null,
"rgpd": [
{
"societeId": 1,
"societeLib": "sample string 2",
"typeFiche": "sample string 3",
"demarchageInterne": true,
"demarchageTiers": true,
"contactMail": true,
"contactTelPro": true,
"contactTelPortablePro": true,
"contactTelPerso": true,
"contactTelPortablePerso": true,
"contactAdresse": true
},
{
"societeId": 1,
"societeLib": "sample string 2",
"typeFiche": "sample string 3",
"demarchageInterne": true,
"demarchageTiers": true,
"contactMail": true,
"contactTelPro": true,
"contactTelPortablePro": true,
"contactTelPerso": true,
"contactTelPortablePerso": true,
"contactAdresse": true
}
]
},
"state": "sample string 1",
"operation": "sample string 2",
"result": {
"code": 100,
"message": "sample string 1",
"detail": "sample string 2"
},
"link": "sample string 3"
}
application/xml, text/xml
Sample:
<APIReturnModelOfClientModel3JrgOwLl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models.APIResponse">
<link xmlns="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models">sample string 3</link>
<operation>sample string 2</operation>
<result>
<code>Continue</code>
<detail>sample string 2</detail>
<message>sample string 1</message>
</result>
<state>sample string 1</state>
<data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models">
<d2p1:CantonINSEE>sample string 14</d2p1:CantonINSEE>
<d2p1:NAF>sample string 20</d2p1:NAF>
<d2p1:SIRET>sample string 19</d2p1:SIRET>
<d2p1:TvaIntra>sample string 18</d2p1:TvaIntra>
<d2p1:activities i:nil="true" />
<d2p1:ad1>sample string 9</d2p1:ad1>
<d2p1:ad2>sample string 10</d2p1:ad2>
<d2p1:adCpl>sample string 8</d2p1:adCpl>
<d2p1:civilite>sample string 4</d2p1:civilite>
<d2p1:cp>sample string 11</d2p1:cp>
<d2p1:email>sample string 23</d2p1:email>
<d2p1:features i:nil="true" />
<d2p1:formeJuridique>sample string 5</d2p1:formeJuridique>
<d2p1:hasTvaIntra>true</d2p1:hasTvaIntra>
<d2p1:id>1</d2p1:id>
<d2p1:insee>sample string 12</d2p1:insee>
<d2p1:invoices i:nil="true" />
<d2p1:memberships i:nil="true" />
<d2p1:nom>sample string 6</d2p1:nom>
<d2p1:nomCpl>sample string 7</d2p1:nomCpl>
<d2p1:numero>sample string 2</d2p1:numero>
<d2p1:orders i:nil="true" />
<d2p1:param1>
<d2p1:code>sample string 3</d2p1:code>
<d2p1:id>1</d2p1:id>
<d2p1:lib>sample string 4</d2p1:lib>
<d2p1:paramName>sample string 2</d2p1:paramName>
</d2p1:param1>
<d2p1:param2>
<d2p1:code>sample string 3</d2p1:code>
<d2p1:id>1</d2p1:id>
<d2p1:lib>sample string 4</d2p1:lib>
<d2p1:paramName>sample string 2</d2p1:paramName>
</d2p1:param2>
<d2p1:payments i:nil="true" />
<d2p1:pays>sample string 15</d2p1:pays>
<d2p1:port>sample string 22</d2p1:port>
<d2p1:regimeTVA>sample string 16</d2p1:regimeTVA>
<d2p1:rgpd>
<d2p1:ClientSocieteRGPDModel>
<d2p1:contactAdresse>true</d2p1:contactAdresse>
<d2p1:contactMail>true</d2p1:contactMail>
<d2p1:contactTelPerso>true</d2p1:contactTelPerso>
<d2p1:contactTelPortablePerso>true</d2p1:contactTelPortablePerso>
<d2p1:contactTelPortablePro>true</d2p1:contactTelPortablePro>
<d2p1:contactTelPro>true</d2p1:contactTelPro>
<d2p1:demarchageInterne>true</d2p1:demarchageInterne>
<d2p1:demarchageTiers>true</d2p1:demarchageTiers>
<d2p1:societeId>1</d2p1:societeId>
<d2p1:societeLib>sample string 2</d2p1:societeLib>
<d2p1:typeFiche>sample string 3</d2p1:typeFiche>
</d2p1:ClientSocieteRGPDModel>
<d2p1:ClientSocieteRGPDModel>
<d2p1:contactAdresse>true</d2p1:contactAdresse>
<d2p1:contactMail>true</d2p1:contactMail>
<d2p1:contactTelPerso>true</d2p1:contactTelPerso>
<d2p1:contactTelPortablePerso>true</d2p1:contactTelPortablePerso>
<d2p1:contactTelPortablePro>true</d2p1:contactTelPortablePro>
<d2p1:contactTelPro>true</d2p1:contactTelPro>
<d2p1:demarchageInterne>true</d2p1:demarchageInterne>
<d2p1:demarchageTiers>true</d2p1:demarchageTiers>
<d2p1:societeId>1</d2p1:societeId>
<d2p1:societeLib>sample string 2</d2p1:societeLib>
<d2p1:typeFiche>sample string 3</d2p1:typeFiche>
</d2p1:ClientSocieteRGPDModel>
</d2p1:rgpd>
<d2p1:subscriptions i:nil="true" />
<d2p1:tel>sample string 21</d2p1:tel>
<d2p1:type>sample string 3</d2p1:type>
<d2p1:ville>sample string 13</d2p1:ville>
</data>
</APIReturnModelOfClientModel3JrgOwLl>