POST apioauth/installations/{installationId}/photodescriptions
Create a photo description for an installation
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
installationId |
The installation id the description belongs too |
integer |
Required |
Body Parameters
The CreatePhotoDescriptionRequest
CreatePhotoDescriptionRequestName | Description | Type | Additional information |
---|---|---|---|
Description |
The description for the photos |
string |
None. |
InstallationPhotoType |
The type of the photos |
InstallationPhotoType |
None. |
Request Formats
application/json, text/json
Sample:
{ "Description": "sample string 1", "InstallationPhotoType": 0 }
application/xml, text/xml
Sample:
<CreatePhotoDescriptionRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Description>sample string 1</Description> <InstallationPhotoType>Damage</InstallationPhotoType> </CreatePhotoDescriptionRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A CreatePhotoDescriptionResponse
CreatePhotoDescriptionResponseName | Description | Type | Additional information |
---|---|---|---|
PhotoDescriptionId |
The id of the photo description created |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "PhotoDescriptionId": 1 }
application/xml, text/xml
Sample:
<CreatePhotoDescriptionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PhotoDescriptionId>1</PhotoDescriptionId> </CreatePhotoDescriptionResponse>