POST api/v2/objects/create

CreateObject

Request Information

URI Parameters

None.

Body Parameters

The command

Name	Type	Additional information
Name	string	Required Max length: 100
Description	string	Max length: 250
Email	string	Data type: EmailAddress Max length: 256
TelephoneNumber	string	Max length: 60
TotalFloorArea	integer (32 bits)	Range: inclusive between 0 and 1000000
ConstructionYear	integer (32 bits)	Range: inclusive between 1000 and 2100
Street	string	Required Max length: 64
StreetNumber	string	Required Max length: 32
PostalCode	string	Required Max length: 16
Locality	string	Required Max length: 64
AdministrativeArea	string	Max length: 64
CountryId	universally unique identifier	Required
Remarks	string	Max length: 1000

Request Formats

application/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Email": "sample string 3",
  "TelephoneNumber": "sample string 4",
  "TotalFloorArea": 1,
  "ConstructionYear": 1,
  "Street": "sample string 5",
  "StreetNumber": "sample string 6",
  "PostalCode": "sample string 7",
  "Locality": "sample string 8",
  "AdministrativeArea": "sample string 9",
  "CountryId": "00000000-0000-0000-0000-000000000000",
  "Remarks": "sample string 10"
}

Response Information

Resource Description

CreateObjectCommandResult

Name	Description	Type	Additional information
Result		CreateObjectCommandResultKind	Required
ObjectId		universally unique identifier	Required

Response Formats

application/json

Sample:

{
  "Result": "Success",
  "ObjectId": "00000000-0000-0000-0000-000000000000"
}