UpdateOrganization Documentation
UpdateOrganization
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
WOC | WOC123456789012 | WOC of Organization | |
Address | Address as Address | ||
BusinessSector | Software Editor | Business Sector (free) | |
Description | My Organization new description | Description | |
LegalName | MyOrgSA | Legal name | |
Name | My Organization name | Name | |
OrganizationType | WOC123456789012 | Type as OrganizationTypeEnum | |
OtherIN | OtherID | Other international identifier | |
Siret | WOC123456789012 | WOC of Organization owner | |
Url | http://www.myorg.com | Url | |
Vatin | FR0123456789 | Vatin |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.jsv
suffix or?format=jsv
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /jsv/reply/UpdateOrganization HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: UpdateOrganization,
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/jsv" -X PUT -d @filename.jsv https://api.wit-datacenter.com/Organization/WOC123456789012
Remark
@filename.jsv
contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Updated OrganizationJSV Sample
HTTP/1.1 200 OK Content-Type: text/jsv 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-01, updateDate: 0001-01-01, id: 0, picture: 00000000000000000000000000000000, name: String }