Creating a new MSP partner
URI - POST
To use this endpoint, send a POST request to create a new MSP Partner: msp/msp-partners-extended
|
|
Note - It is a newer version of the existing |
Request
The request includes HTTP headers (obtained in the authentication/authorization process and used to sign the request) with a request body in JSON format.
Note - The request body must include the name of the MSP.
Request Headers
|
Header |
Type |
Required |
Format |
Description/Sample |
|---|---|---|---|---|
|
x-av-req-id |
String |
Yes |
UUID – generated and supplied on the request |
d290f1ee-6c54-4b01-90e6-d701748f0851 |
|
x-av-token |
String |
Yes |
Token obtained in the authentication sequence |
tkn8546ffffggd9d8934593 |
|
x-av-app-id |
String |
Yes |
Application ID provided by Avanan |
myapp29 |
|
x-av-date |
String |
Yes |
Date-time in GMT |
'2016-08-29T09:12:33.001Z' |
|
x-av-sig |
String |
Yes |
Calculated signature |
tkn8jmveolrrtertr9d8934593 |
Request Body
All applicable request parameters are posted on the request body JSON:
{
"requestData":
{ "name": "string”,
"website": "string",
"country": "string",
"state": "string",
"zip": "string",
}
}Request Body Parameters
The JSON parameters:
|
Parameter |
Type |
Required |
Format |
Description/Sample |
|---|---|---|---|---|
|
name |
String |
Yes |
|
Name of the new MSP |
|
website |
String |
Yes |
URL |
|
|
country |
String |
Yes |
|
The country the MSP is located in. Must be one of the values from the country list. See Allowed Country Values. |
|
state |
String |
Conditional |
|
Required only if country is "United States". Must be one of the values from the US states list. See Allowed State Values. |
|
zip |
String |
Yes |
|
|
Request sample (CURL) format
This request sample shows URI base in USA region. For URI base in other regions, see MSP Types.
curl -X POST -H "Accept: application/json" \
-H "x-av-req-id: d290f1ee-6c54-4b01-90e6-d701748f0851" \
-H "x-av-token: tkn8546ffffggd9d8934593" \
-H "x-av-app-id: myapp29" \
-H "x-av-date: 2016-08-29T09:12:33.001Z" \
-H "x-av-sig: tkn8jmveolrrtertr9d8934593" \
https://smart-api-production-1-us.avanan.net/v1.0/msp/msp-partners-extendedResponse
The response obtained from the service includes an HTTP response code and JSON formatted structure. The structure consists of a responseEnvelope structure and a responseData object that holds the details of the newly created MSP.
Response Structure
A valid response from the service in JSON:
{
"responseEnvelope":
{ "requestId": "string",
"responseCode": 0,
"responseText": "",
"additionalText": "",
"recordsNumber": 0,
"scrollId": "string" }
,
"responseData":
{ "id": 0,
"name": "string",
"website": "string",
"country": "string",
"state": "string",
"zip": "string" }
}Response Parameters
The response parameters:
|
Parameter |
Type |
Description |
|
|---|---|---|---|
|
responseEnvelope |
Object |
A container of metadata properties |
|
|
|
requestId |
String |
Request ID (from the request header x-av-req-id value) |
|
|
responseCode |
Integer |
0 = Success Other values = Failure |
|
|
responseText |
String |
The text value of the response |
|
|
additionalText |
String |
Additional information |
|
|
recordsNumber |
Integer |
Number of records in the response |
|
|
scrollId |
String |
A unique ID used to scroll through data |
|
responseData |
Object |
Array of tenants |
|
|
|
id |
Integer |
Unique ID of the MSP |
|
|
name |
String |
Name of the MSP |
|
|
website |
String |
Website associated with the MSP |
|
|
country |
String |
The country the MSP is located in |
|
|
state |
String |
The state the MSP is located in |
|
|
zip |
String |
Zip of the MSP |
Allowed Country Values
In the country field, it allows the following values.
|
|
Note - The values are case-sensitive. Ensure you use the correct capitalization. |
|
Afghanistan |
Åland Islands |
Albania |
Algeria |
American Samoa |
| Andorra | Angola | Anguilla | Antarctica | Antigua and Barbuda |
| Argentina | Armenia | Aruba | Australia | Austria |
| Azerbaijan | Bahamas | Bahrain | Bangladesh | Barbados |
| Belarus | Belgium | Belize | Benin | Bermuda |
| Bhutan | Bolivia (Plurinational State of) | Bonaire, Sint Eustatius and Saba | Bosnia and Herzegovina | Botswana |
| Bouvet Island | Brazil | British Indian Ocean Territory | Brunei Darussalam | Bulgaria |
| Burkina Faso | Burundi | Cabo Verde | Cambodia | Cameroon |
| Canada | Cayman Islands | Central African Republic | Chad | Chile |
| China | Christmas Island | Cocos (Keeling) Islands | Colombia | Comoros |
| Congo | Congo, Democratic Republic of the | Cook Islands | Costa Rica | Croatia |
| Cuba | Curaçao | Cyprus | Czechia | Côte d'Ivoire |
| Denmark | Djibouti | Dominica | Dominican Republic | Ecuador |
| Egypt | El Salvador | Equatorial Guinea | Eritrea | Estonia |
| Eswatini | Ethiopia | Falkland Islands (Malvinas) | Faroe Islands | Fiji |
| Finland | France | French Guiana | French Polynesia | French Southern Territories |
| Gabon | Gambia | Georgia | Germany | Ghana |
| Gibraltar | Greece | Greenland | Grenada | Guadeloupe |
| Guam | Guatemala | Guernsey | Guinea | Guinea-Bissau |
| Guyana | Haiti | Heard Island and McDonald Islands | Holy See | Honduras |
| Hong Kong | Hungary | Iceland | India | Indonesia |
| Iran (Islamic Republic of) | Iraq | Ireland | Isle of Man | Israel |
| Italy | Jamaica | Japan | Jersey | Jordan |
| Kazakhstan | Kenya | Kiribati | Korea (Democratic People's Republic of) | Korea, Republic of |
| Kuwait | Kyrgyzstan | Lao People's Democratic Republic | Latvia | Lebanon |
| Lesotho | Liberia | Libya | Liechtenstein | Lithuania |
| Luxembourg | Macao | Madagascar | Malawi | Malaysia |
| Maldives | Mali | Malta | Marshall Islands | Martinique |
| Mauritania | Mauritius | Mayotte | Mexico | Micronesia (Federated States of) |
| Moldova, Republic of | Monaco | Mongolia | Montenegro | Montserrat |
| Morocco | Mozambique | Myanmar | Namibia | Nauru |
| Nepal | Netherlands | New Caledonia | New Zealand | Nicaragua |
| Niger | Nigeria | Niue | Norfolk Island | North Macedonia |
| Northern Mariana Islands | Norway | Oman | Pakistan | Palau |
| Palestine, State of | Panama | Papua New Guinea | Paraguay | Peru |
| Philippines | Pitcairn | Poland | Portugal | Puerto Rico |
| Qatar | Réunion | Romania | Russian Federation | Rwanda |
| Saint Barthélemy | Saint Helena, Ascension and Tristan da Cunha | Saint Kitts and Nevis | Saint Lucia | Saint Martin (French part) |
| Saint Pierre and Miquelon | Saint Vincent and the Grenadines | Samoa | San Marino | Sao Tome and Principe |
| Saudi Arabia | Senegal | Serbia | Seychelles | Sierra Leone |
| Singapore | Sint Maarten (Dutch part) | Slovakia | Slovenia | Solomon Islands |
| Somalia |
South Africa |
South Georgia and the South Sandwich Islands | South Sudan |
Spain |
| Sri Lanka |
Sudan |
Suriname | Svalbard and Jan Mayen |
Sweden |
| Switzerland |
Syrian Arab Republic |
Taiwan, Province of China | Tajikistan |
Tanzania, United Republic of |
| Thailand |
Timor-Leste |
Togo |
Tokelau |
Tonga |
| Trinidad and Tobago |
Tunisia |
Turkey |
Turkmenistan |
Tuvalu |
| Uganda |
Ukraine |
United Arab Emirates |
United Kingdom of Great Britain and Northern Ireland |
United States |
|
Uruguay |
Uzbekistan |
Vanuatu |
Venezuela (Bolivarian Republic of) |
Viet Nam |
|
Western Sahara |
Yemen |
Zambia |
Zimbabwe |
|
Allowed State Values
If an MSP is created in the US, the state field is also mandatory. The following values are allowed.
|
|
Note - The values are case-sensitive. Ensure you use the correct capitalization. |
|
Alabama |
Alaska |
Arkansas |
Arizona |
California |
|
Colorado |
Connecticut |
Delaware |
Florida |
Georgia |
|
Hawaii |
Idaho |
Illinois |
Indiana |
Iowa |
|
Kansas |
Kentucky |
Louisiana |
Maine |
Maryland |
|
Massachusetts |
Michigan |
Minnesota |
Mississippi |
Missouri |
|
Montana |
Nebraska |
Nevada |
New Hampshire |
New Jersey |
|
New Mexico |
New York |
North Carolina |
North Dakota |
Ohio |
|
Oklahoma |
Oregon |
Pennsylvania |
Rhode Island |
South Carolina |
|
South Dakota |
Tennessee |
Texas |
Utah |
Vermont |
|
Virginia |
Washington |
West Virginia |
Wisconsin |
Wyoming |