Accounts-accountId-Contacts-contactType:PUT
From Hostway API Documentation
(Difference between revisions)
(→Request for updating contact type with not valid data) |
Mike.robski (Talk | contribs) m (1 revision: Release 99) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 21: | Line 21: | ||
<nowiki> | <nowiki> | ||
{ | { | ||
− | + | "name": { | |
− | " | + | "salutation": "{salutation}", |
− | + | "firstName": "{firstname}", | |
− | + | ||
− | + | ||
− | + | ||
− | "firstName": "{ | + | |
− | + | ||
"middleName": "{middleName}", | "middleName": "{middleName}", | ||
+ | "lastName": "{lastName}", | ||
+ | "company": "{company}" | ||
+ | }, | ||
+ | "address": { | ||
+ | "street1": "{street1}", | ||
+ | "street2": "{street2}", | ||
+ | "city": "{city}", | ||
+ | "stateOrProvince": "{stateOrProvince}", | ||
+ | "postalCode": "{postalCode}", | ||
+ | "countryCode": "{countryCode}" | ||
+ | }, | ||
+ | "contactMedia": { | ||
"phone1": "{phone1}", | "phone1": "{phone1}", | ||
"phone2": "{phone2}", | "phone2": "{phone2}", | ||
− | " | + | "fax": "{fax}", |
− | " | + | "email1": "{email1}", |
− | " | + | "email2": "{email2}" |
− | + | } | |
− | + | ||
} | } | ||
</nowiki> | </nowiki> | ||
Line 137: | Line 143: | ||
{ | { | ||
− | + | "name": { | |
− | " | + | "salutation": "Mr.", |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
"firstName": "John", | "firstName": "John", | ||
+ | "middleName": "", | ||
"lastName": "Smith", | "lastName": "Smith", | ||
− | " | + | "company": "TestCo, Inc." |
+ | }, | ||
+ | "address": { | ||
+ | "street1": "100 Main St.", | ||
+ | "street2": "", | ||
+ | "city": "Chicago", | ||
+ | "stateOrProvince": "IL", | ||
+ | "postalCode": "60001", | ||
+ | "countryCode": "US" | ||
+ | }, | ||
+ | "contactMedia": { | ||
"phone1": "555-555-5501", | "phone1": "555-555-5501", | ||
"phone2": "", | "phone2": "", | ||
− | " | + | "fax": "", |
− | " | + | "email1": "test@test.com", |
− | " | + | "email2": "" |
− | + | } | |
− | + | ||
} | } | ||
</nowiki> | </nowiki> | ||
Line 169: | Line 181: | ||
{ | { | ||
− | + | "name": { | |
− | " | + | "salutation": "Mr.", |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
"firstName": "John", | "firstName": "John", | ||
+ | "middleName": "", | ||
"lastName": "Smith", | "lastName": "Smith", | ||
− | " | + | "company": "TestCo, Inc." |
+ | }, | ||
+ | "address": { | ||
+ | "street1": "100 Main St.", | ||
+ | "street2": "", | ||
+ | "city": "Chicago", | ||
+ | "stateOrProvince": "IL", | ||
+ | "postalCode": "60001", | ||
+ | "countryCode": "US" | ||
+ | }, | ||
+ | "contactMedia": { | ||
"phone1": "555-555-5501", | "phone1": "555-555-5501", | ||
"phone2": "", | "phone2": "", | ||
− | " | + | "fax": "", |
− | " | + | "email1": "test@test.com", |
− | " | + | "email2": "" |
− | + | } | |
− | + | ||
} | } | ||
</nowiki> | </nowiki> | ||
Line 210: | Line 228: | ||
{ | { | ||
− | + | "name": { | |
− | " | + | "salutation": "Mr.", |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
"firstName": "John", | "firstName": "John", | ||
− | |||
"middleName": "", | "middleName": "", | ||
+ | "lastName": "Smith", | ||
+ | "company": "TestCo, Inc." | ||
+ | }, | ||
+ | "address": { | ||
+ | "street1": "100 Main St.", | ||
+ | "street2": "", | ||
+ | "city": "Chicago", | ||
+ | "stateOrProvince": "IL", | ||
+ | "postalCode": "60001", | ||
+ | "countryCode": "USA" | ||
+ | }, | ||
+ | "contactMedia": { | ||
"phone1": "555-555-5501", | "phone1": "555-555-5501", | ||
"phone2": "", | "phone2": "", | ||
− | " | + | "fax": "", |
− | " | + | "email1": "test@test.com", |
− | " | + | "email2": "" |
− | + | } | |
− | + | ||
} | } | ||
</nowiki> | </nowiki> | ||
Line 254: | Line 278: | ||
{ | { | ||
− | + | "name": { | |
− | " | + | "salutation": "Mr.", |
− | + | ||
− | + | ||
− | + | ||
"firstName": "", | "firstName": "", | ||
+ | "middleName": "", | ||
"lastName": "Smith", | "lastName": "Smith", | ||
− | " | + | "company": "TestCo, Inc." |
+ | }, | ||
+ | "address": { | ||
+ | "street1": "100 Main St.", | ||
+ | "street2": "", | ||
+ | "city": "Chicago", | ||
+ | "stateOrProvince": "IL", | ||
+ | "postalCode": "60001" | ||
+ | }, | ||
+ | "contactMedia": { | ||
"phone1": "555-555-5501", | "phone1": "555-555-5501", | ||
"phone2": "", | "phone2": "", | ||
− | " | + | "fax": "", |
− | " | + | "email1": "test@test.com", |
− | " | + | "email2": "" |
− | + | } | |
− | + | ||
} | } | ||
</nowiki> | </nowiki> |
Latest revision as of 10:07, 14 October 2014
PUT /accounts/{accountId}/contacts/{contactType}
Set specific contact type for an account
Contents |
Request
PUT /accounts/{accountId}/contacts/{contactType}
Parameters
- accountId - string
- The Id of the account.
- contactType - string
- Contact type. One of 'regular', 'billing', 'administrator', 'technical'
URI Parameters
None.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Request Body
{ "name": { "salutation": "{salutation}", "firstName": "{firstname}", "middleName": "{middleName}", "lastName": "{lastName}", "company": "{company}" }, "address": { "street1": "{street1}", "street2": "{street2}", "city": "{city}", "stateOrProvince": "{stateOrProvince}", "postalCode": "{postalCode}", "countryCode": "{countryCode}" }, "contactMedia": { "phone1": "{phone1}", "phone2": "{phone2}", "fax": "{fax}", "email1": "{email1}", "email2": "{email2}" } }
Parameters
- city - string
- (REQUIRED)
- May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'
- company - string
- (OPTIONAL)
- May be up to 200 characters long. May contain only alphanumeric, white space and the following characters: -.'
- countryCode - string
- (REQUIRED)
- ISO 3166-1 alpha-2[2] country code.
- email1 - string
- (REQUIRED)
- May be up to 100 characters long. Must contain a valid e-mail address.
- email2 - string
- (OPTIONAL)
- May be up to 100 characters long. If provided, must contain a valid e-mail address.
- fax - string
- (OPTIONAL)
- May be up to 20 characters long. If provided, must contain ITU-T E.164[3] formatted phone number.
- firstName - string
- (REQUIRED)
- May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'
- lastName - string
- (REQUIRED)
- May be up to 50 characters long. May contain only alphanumeric, white space and the following characters: -.'
- middleName - string
- (OPTIONAL)
- May be up to 50 characters long. If provided, may contain only alphanumeric, white space and the following characters: -.'
- phone1 - string
- (REQUIRED)
- May be up to 20 characters long. Must contain ITU-T E.164[4] formatted phone number.
- phone2 - string
- (OPTIONAL)
- May be up to 20 characters long. If provided, must contain ITU-T E.164[5] formatted phone number.
- postalCode - string
- (OPTIONAL)
- May be up to 30 characters long. May contain only alphanumeric, white space and the following characters: -.' This value is *required* if the value of countryCode is "US" or "CA". If the value of countryCode is "US", then postalCode must be in format "#####" or "#####-####" (where "#" represents any numeric digit). If the value of countryCode is "CA", then postalCode must be in format "A#A#A#" or "A#A-#A#" or "A#A #A#" (where "A" represents any latin alphabet character and "#" represents any numeric digit).
- salutation - string
- (OPTIONAL)
- May contain one of the salutations provided by GET /salutations
- stateOrProvince - string
- (OPTIONAL)
- May be up to 20 characters long. May contain only alphanumeric, white space and the following characters: -.' This value is *required* if the value of countryCode is "US" or "CA". If the value of countryCode is "US", then stateOrProvince must be a valid two-letter US state abbreviation. If the value of countryCode is "CA", then stateOrProvince must be a valid two-letter Canadian province abbreviation.
- street1 - string
- (REQUIRED)
- May be up to 100 characters long. May contain only alphanumeric, white space and the following characters: -.'
- street2 - string
- (OPTIONAL)
- May be up to 100 characters long. If provided, may contain only alphanumerics, white space and the following characters: -.'
Response
Status Code
- 204 No Content
- Successfully updated contact information
- 400 Bad Request
- Contact information was not updated because either the request body was malformed, or some element of the request body did not meet the requirements.
- 401 Unauthorized
- The request was sent without an Authorization header, or the user represented by the value of this header was not properly authenticated.
- 403 Forbidden
- The user authenticated for this request is not allowed to access the resource.
- 404 Not Found
- The account Id was not found.
Response Body
None.
Examples
Successful update of contact information
Request
PUT /accounts/{accountId}/contacts/regular Authorization: Basic {Base64-encoded username & password string} { "name": { "salutation": "Mr.", "firstName": "John", "middleName": "", "lastName": "Smith", "company": "TestCo, Inc." }, "address": { "street1": "100 Main St.", "street2": "", "city": "Chicago", "stateOrProvince": "IL", "postalCode": "60001", "countryCode": "US" }, "contactMedia": { "phone1": "555-555-5501", "phone2": "", "fax": "", "email1": "test@test.com", "email2": "" } }
Response
204 No Content
Request for updating non-existent contact type
Request
PUT /accounts/{accountId}/contacts/fake Authorization: Basic {Base64-encoded username & password string} { "name": { "salutation": "Mr.", "firstName": "John", "middleName": "", "lastName": "Smith", "company": "TestCo, Inc." }, "address": { "street1": "100 Main St.", "street2": "", "city": "Chicago", "stateOrProvince": "IL", "postalCode": "60001", "countryCode": "US" }, "contactMedia": { "phone1": "555-555-5501", "phone2": "", "fax": "", "email1": "test@test.com", "email2": "" } }
Response
404 Not Found { "itemNotFound": { "guid": {identifier}, "message": "Resource not found", "code": 404, "details": "" } }
Request for updating contact type with not valid data
Request
PUT /accounts/{accountId}/contacts/regular Authorization: Basic {Base64-encoded username & password string} { "name": { "salutation": "Mr.", "firstName": "John", "middleName": "", "lastName": "Smith", "company": "TestCo, Inc." }, "address": { "street1": "100 Main St.", "street2": "", "city": "Chicago", "stateOrProvince": "IL", "postalCode": "60001", "countryCode": "USA" }, "contactMedia": { "phone1": "555-555-5501", "phone2": "", "fax": "", "email1": "test@test.com", "email2": "" } }
Response
400 Bad Request { "badRequest": { "guid": {identifier}, "message": "POST data error", "code": 400, "details": { "countryCode": "Invalid Country Code" } } }
Request for updating contact type with missing or empty required data
Request
PUT /accounts/{accountId}/contacts/regular Authorization: Basic {Base64-encoded username & password string} { "name": { "salutation": "Mr.", "firstName": "", "middleName": "", "lastName": "Smith", "company": "TestCo, Inc." }, "address": { "street1": "100 Main St.", "street2": "", "city": "Chicago", "stateOrProvince": "IL", "postalCode": "60001" }, "contactMedia": { "phone1": "555-555-5501", "phone2": "", "fax": "", "email1": "test@test.com", "email2": "" } }
Response
400 Bad Request { "badRequest": { "guid": {identifier}, "message": "POST data error", "code": 400, "details": { "countryCode": "Required", "firstName": "Required" } } }
See also