API / Region

Entity Description:

Region works in conjunction with Business to identify and group PoliteMail Users by location (e.g. territories, State, East Coast, West Coast, North America, South America, etc….).

 

Properties

Name Description Type Additional
Information
ID Int32
Name String

 

Entity Statement

Creating a Region
Request
POST /ssv3/odata/Regions
Content-Type     
application/json
  Request body
{
“ID”:”0″,”Name”:”New Region”
}
Response body
{
“ID”:1,”Name”:”New Region”
}
Deleting a Region
  Request
  DELETE /ssv3/odata/Regions(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Region
  Request
  GET /ssv3/odata/Regions(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”Name”:”New Region”
}
Updating a Region
  Request
  PUT /ssv3/odata/Regions(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Name”:”New Region”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Regions
  Request
  GET /ssv3/odata/Regions
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”New Region”
},{
“ID”:1,”Name”:”New Region”
}]