POST v1/Country

Description

Add a new Country

Base Url

https://api-mgi.uat.wsohosting.com/


Rest Call Syntax


POST Reference/v1/Country

POST Reference/v1/Country

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



CountryAdd

Name

Description

Type

Additional Information

Abbreviation

The abbreviaton of the country

string

Required

CurrencyCode

The Currency code of the currency for the Country

string

Required

Description

The name of the country

string

Required

Notes

The notes for the country

string

Region

The region for the country

string




Limitations

There are no limitations specified.




Request Information


Request body formats


application/json, text/json

Sample:
{
  "description": "sample string 1",
  "abbreviation": "sample string 2",
  "currencyCode": "sample string 3",
  "notes": "sample string 4",
  "region": "sample string 5"
}

application/xml, text/xml

Sample:
<CountryAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Abbreviation>sample string 2</Abbreviation>
  <CurrencyCode>sample string 3</CurrencyCode>
  <Description>sample string 1</Description>
  <Notes>sample string 4</Notes>
  <Region>sample string 5</Region>
</CountryAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



Country

Name

Description

Type

Additional Information

Abbreviation

The Country Abbreviation

string

Currency

Link to Currency

CurrencyCode

Currency Code

string

Description

Name of country.

string

Id

The unique ID for this object.

integer

IsDeleted

True or False - Has this Country been soft deleted from the system?

boolean

Links

The Hateoas links to related object

Collection of Link

Notes

Notes about this country.

string

Region

Region of world.

string




Response Body Formats



application/json, text/json

Sample:
{
  "abbreviation": "sample string 1",
  "id": 2,
  "description": "sample string 3",
  "currencyCode": "sample string 5",
  "currency": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "isDeleted": true,
  "notes": "sample string 7",
  "region": "sample string 8",
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ]
}

application/xml, text/xml

Sample:
<Country xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WSO.API.Reference.Models.v1">
  <Abbreviation>sample string 1</Abbreviation>
  <Currency>
    <Rel xmlns="">sample string 2</Rel>
    <Uri xmlns="">http://webapihelppage3.com/</Uri>
    <Verb xmlns="">sample string 1</Verb>
  </Currency>
  <CurrencyCode>sample string 5</CurrencyCode>
  <Description>sample string 3</Description>
  <Id>2</Id>
  <IsDeleted>true</IsDeleted>
  <Links>
    <Link xmlns="">
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link xmlns="">
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <Notes>sample string 7</Notes>
  <Region>sample string 8</Region>
</Country>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.