Orders-orderId-account-contactInfo-contactType:PUT
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 85) |
Mike.robski (Talk | contribs) |
||
Line 73: | Line 73: | ||
; stateOrProvince - ''string'' | ; stateOrProvince - ''string'' | ||
− | : Required string max 20 characters. May contain only alphanumerics, white space and the following characters: -.' | + | : Required string max 20 characters. May contain only alphanumerics, white space and the following characters: -.' If the selected country is United States, then this must be a valid two-letter US state abbreviation. If the selected country is Canada, then this value must be a valid two-letter Canadian province abbreviation. |
; postalCode - ''string'' | ; postalCode - ''string'' | ||
− | : Required string max 30 characters. May contain only alphanumerics, white space and the following characters: -.' | + | : Required string max 30 characters. May contain only alphanumerics, white space and the following characters: -.' If the selected country is United States, then the postalCode must be in format "#####" or "#####-####" (where "#" represents any numeric digit). If the selected country is Canada, then the 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). |
; country - ''string'' | ; country - ''string'' |
Revision as of 16:11, 28 October 2013
PUT /orders/{orderId}/account/contactInfo/{contactType}
Set the account contact details for a given contact type in an order.
Contents |
Request
PUT /orders/{orderId}/account/contactInfo/{contactType}
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
- contact_type - string
- Contact Type (regular, billing, administrator or technical)
URI Parameters
None.
Request Headers
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
Request Body
{ "name": { "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}", "email1Format": "{html|text}", "email2": "{email2}", "email2Format": "{html|text}" } }
Parameters
- firstName - string
- Required string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'
- middleName - string
- Optional string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'
- lastName - string
- Required string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'
- company - string
- Optional string max 200 characters. May contain only alphanumerics, white space and the following characters: -.'
- street1 - string
- Required string max 100 characters. May contain only alphanumerics, white space and the following characters: -.'
- street2 - string
- Optional string max 100 characters. May contain only alphanumerics, white space and the following characters: -.'
- city - string
- Required string max 50 characters. May contain only alphanumerics, white space and the following characters: -.'
- stateOrProvince - string
- Required string max 20 characters. May contain only alphanumerics, white space and the following characters: -.' If the selected country is United States, then this must be a valid two-letter US state abbreviation. If the selected country is Canada, then this value must be a valid two-letter Canadian province abbreviation.
- postalCode - string
- Required string max 30 characters. May contain only alphanumerics, white space and the following characters: -.' If the selected country is United States, then the postalCode must be in format "#####" or "#####-####" (where "#" represents any numeric digit). If the selected country is Canada, then the 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).
- country - string
- Required string ISO 3166-1 alpha-2[1] country code.
- phone1 - string
- Required string ITU-T E.164[2] formatted phone number max 20 digits.
- phone2 - string
- Optional string ITU-T E.164[3] formatted phone number max 20 digits.
- fax - string
- Optional string ITU-T E.164[4] formatted phone number max 20 digits.
- email1 - string
- Required string valid e-mail address max 100 characters.
- email1Format - string
- Required string – one of html or text.
- email2 - string
- Optional string valid e-mail address max 100 characters.
- email2Format - string
- Optional string – one of html or text.
Response
Status Code
- 204 No Content
- The operation was successfully completed.
- 400 Bad Request
- The request body contains invalid JSON or the values do not adhere to the restrictions set for them.
- 404 Not Found
- An account has not been added to the given order or the order does not exist.
Response Body
None.
See also