DefineOrganization Documentation
DefineOrganization
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
Address | Address as Address | ||
BusinessSector | Software Editor | Business Sector (free) | |
Description | My Organization description | Description | |
LegalName | MyOrgSA | Legal name | |
Name | My organization name | Name | |
OrganizationType | Collectivity | Organization type as OrganizationTypeEnum | |
OtherIN | OtherID | Other international identifier | |
Siret | WOC123456789012 | Organization siret. Leave empty if unknwown | |
Url | http://www.myorg.com | Url | |
Vatin | FR0123456789 | Organization vatin. Leave empty if unknwown | |
WOC | WOC123456789012 | Organization WOC of Organization. Leave empty if unknwown |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.json
suffix or?format=json
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /json/reply/DefineOrganization HTTP/1.1
Host: localhost
Content-Type: application/json
Content-Length: length
{"wType":"DefineOrganization","woc":"String","siret":"String","vatin":"String","otherIN":"String","businessSector":"String","legalName":"String","organizationType":"Other","name":"String","url":"String","description":"String","address":{"wType":"Address","phone":"String","fax":"String","address":"String","postalCode":"String","city":"String","countryID":0}}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/json" -X POST -d @filename.json https://api.wit-datacenter.com/Organization
Remark
@filename.json
contain your request parameters serialized in JSON as described in Post Data sample bottom
Response
Returned Entity
Created or retreived OrganizationJSON Sample
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"wType":"Organization","status":"ToValidate","woc":"String","siret":"String","vatin":"String","otherIN":"String","businessSector":"String","legalName":"String","organizationType":"Other","address":{"wType":"Address","phone":"String","fax":"String","address":"String","postalCode":"String","city":"String","countryID":0},"url":"String","description":"String","creationDate":"0001-01-01T00:00:00.0000000Z","updateDate":"0001-01-01T00:00:00.0000000Z","id":0,"picture":"00000000000000000000000000000000","name":"String"}