{"swagger":"2.0","info":{"version":"v4-propertymanagement","title":"agentOS Api V4, Property Management Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/propertymanagement/{shortName}/company/branches/{branchID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific branch given its unique Object ID (OID)","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique ID of the Branch","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModel"}}}}},"/v4/propertymanagement/{shortName}/company/branches/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All branches defined for a company","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModelResults"}}}}},"/v4/propertymanagement/{shortName}/company/company":{"get":{"tags":["CompanyController"],"summary":"Information about a specific company","operationId":"CompanyController_GetCompany","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCompanyModel"}}}}},"/v4/propertymanagement/{shortName}/company/object/{objectID}/customfield":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field by ObjectID:-","operationId":"CompanyController_GetCustomfieldbyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCustomField"}}}}},"/v4/propertymanagement/{shortName}/company/objects/{objectID}/{fieldID}/customfield":{"post":{"tags":["CompanyController"],"summary":"Set Custom Field Value:-","operationId":"CompanyController_SetCustomFieldValue","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"},{"name":"value","in":"body","description":"Value to enter (string)","required":true,"schema":{"$ref":"#/definitions/BaseCustomFieldSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/company/objects/{objectID}/{fieldID}/value":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field Value:-","operationId":"CompanyController_GetCustomFieldValue","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/propertymanagement/{shortName}/leads/{leadSourceID}/sourceTypes":{"get":{"tags":["LeadsController"],"summary":"Get Lead Source by OID:-","operationId":"LeadsController_GetLeadSourceTypeByOID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"leadSourceID","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LeadsTypeModel"}}}}},"/v4/propertymanagement/{shortName}/leads/create":{"post":{"tags":["LeadsController"],"summary":"Set Lead:-","operationId":"LeadsController_SetLeads","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"leadSubmissionModel","in":"body","description":"The submission model","required":true,"schema":{"$ref":"#/definitions/LeadPersonSubmissionModel"}},{"name":"leadType","in":"query","description":"The Lead Type","required":true,"type":"string","enum":["Email","Phone"]},{"name":"leadSource","in":"query","description":"The Lead Source","required":true,"type":"string","enum":["InPerson","PhoneCall","Email","MarketingWebsite","PortalRightmove","PortalOnTheMarket","OnlineBrochure","PortalOther"]}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/leads/sourceTypes/{offset}/{count}":{"get":{"tags":["LeadsController"],"summary":"Get All Lead Source Types:-","operationId":"LeadsController_GetLeadSourceTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LeadsTypeModelResults"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/{floorPlanID}/deletefloorplan":{"delete":{"tags":["LettingsController"],"summary":"Delete floor plan from a lettings property:-","operationId":"LettingsController_DeleteFloorPlanLettingsProperty","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"floorPlanID","in":"path","description":"Floor plan to delete","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/{lettingsPropertyID}/addfloorplan":{"patch":{"tags":["LettingsController"],"summary":"Add floor plan to Lettings Property:-","operationId":"LettingsController_UploadFloorPlan","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"lettingsPropertyID","in":"path","description":"Lettings property to add floorplan to","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Add photo","required":true,"schema":{"$ref":"#/definitions/BasePhotoUploadSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/{lettingsPropertyID}/addphoto":{"patch":{"tags":["LettingsController"],"summary":"Add photo to a lettings property:-","operationId":"LettingsController_UploadPhoto","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"lettingsPropertyID","in":"path","description":"Lettings property to add photo","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Add photo","required":true,"schema":{"$ref":"#/definitions/BasePhotoUploadSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/{lettingsPropertyID}/portalmedia":{"post":{"tags":["LettingsController"],"summary":"Submit portal media to lettings property:-","operationId":"LettingsController_SubmitPortalMedia","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"lettingsPropertyID","in":"path","description":"Lettings Property to add portal media to","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Data of portal media to submit","required":true,"schema":{"$ref":"#/definitions/BasePortalMediaSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/{photoID}/deletephoto":{"delete":{"tags":["LettingsController"],"summary":"Delete photo from a lettings property:-","operationId":"LettingsController_DeletePhotoLettingsProperty","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"photoID","in":"path","description":"Photo to delete","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/{propertyID}/photos/type/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Retrieve Lettings photos with optional photo types:-","operationId":"LettingsController_LettingsPhotosByPhotoType","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique ID of the property","required":true,"type":"string"},{"name":"photoType","in":"query","description":"The Optional PhotoType","required":false,"type":"string","enum":["Photo","Map","FloorPlan","SiteMap","AerialPhoto","StreetView","FloodMap"]},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPhotoModelResults"}}}}},"/v4/propertymanagement/{shortname}/lettings/lettingsproperty/{propertyID}/portalmedia/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Get Portal Media belonging to a property","operationId":"LettingsController_getPortalMedia","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortname","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique ID of the Property","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPortalMediaResults"}}}}},"/v4/propertymanagement/{shortName}/lettings/lettingsproperty/portalmedia/types":{"get":{"tags":["LettingsController"],"summary":"Get portal media types:-","operationId":"LettingsController_GetPortalMediaTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"offset","in":"query","description":"Index of first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"Number of results to return (max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseSystemTypeModelResults"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstruction/{floorPlanID}/deletefloorplan":{"delete":{"tags":["SalesController"],"summary":"Delete floor plan from a sales instruction:-","operationId":"SalesController_DeleteFloorPlanSalesInstruction","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"floorPlanID","in":"path","description":"Floor plan to delete","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstruction/{photoID}/deletephoto":{"delete":{"tags":["SalesController"],"summary":"Delete floor plan from a sales instruction:-","operationId":"SalesController_DeletePhotoSalesInstruction","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"photoID","in":"path","description":"Photo to delete","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstruction/{salesInstructionID}/addfloorplan":{"patch":{"tags":["SalesController"],"summary":"Add floor plan to sales instruction:-","operationId":"SalesController_UploadFloorPlan","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"Sales Instruction to add floorplan to","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Add photo","required":true,"schema":{"$ref":"#/definitions/BasePhotoUploadSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/sales/salesInstruction/{salesInstructionID}/addphoto":{"patch":{"tags":["SalesController"],"summary":"Add photo to a sales instruction:-","operationId":"SalesController_UploadPhoto","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"sales instruction to add photo","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Add photo","required":true,"schema":{"$ref":"#/definitions/BasePhotoUploadSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstructions/{salesInstructionID}/floorplans/{offset}/{count}":{"get":{"tags":["SalesController"],"operationId":"SalesController_GetSalesInstructionsFloorPlans","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","required":true,"type":"string"},{"name":"offset","in":"path","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPhotoModelResults"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstructions/{salesInstructionID}/photos/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"A collection showing all the photos linked to this sales instruction:-","operationId":"SalesController_GetSalesInstructionPhotos","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the sales instruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPhotoModelResults"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstructions/{salesInstructionID}/portalmedia":{"post":{"tags":["SalesController"],"summary":"Submit portal media to sales instruction:-","operationId":"SalesController_SubmitPortalMedia","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"Sales instruction to add portal media to","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Data of portal media to submit","required":true,"schema":{"$ref":"#/definitions/BasePortalMediaSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstructions/{salesInstructionID}/portalmedia/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"Get Portal Media belonging to a property","operationId":"SalesController_getPortalMedia","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the Sales Instruction","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingPortalMediaResults"}}}}},"/v4/propertymanagement/{shortName}/sales/salesinstructions/portalmedia/types":{"get":{"tags":["SalesController"],"summary":"Get portal media types:-","operationId":"SalesController_GetPortalMediaTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"Unique client shortname","required":true,"type":"string"},{"name":"offset","in":"query","description":"Index of first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"Number of results to return (max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseSystemTypeModelResults"}}}}}},"definitions":{"BaseBranchModelResults":{"description":"Holds results from a paged query returning BranchModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/BaseBranchModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseBranchModel":{"description":"Defines a single branch of a client.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The branch name.","type":"string"},"CompanyName":{"description":"The relevant company name, if not the one specified on the branch then the one on company.","type":"string"},"Address1":{"description":"Branch address line 1.","type":"string"},"Address2":{"description":"Branch address line 2.","type":"string"},"Address3":{"description":"Branch address line 3.","type":"string"},"Address4":{"description":"Branch address line 4.","type":"string"},"Postcode":{"description":"Branch address postcode.","type":"string"},"WebAddress":{"description":"Branch web address.","type":"string"},"EMailAddress":{"description":"Branch email address.","type":"string"},"LandPhone":{"description":"Branch land phone number.","type":"string"},"FaxPhone":{"description":"Branch fax phone number.","type":"string"},"County":{"description":"County","type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseHypermediaLink":{"description":"Hypermedia Link Class","type":"object","properties":{"Relationship":{"description":"The hypermedia link relationship to current result object.","type":"string"},"Href":{"description":"The hypermedia href","type":"string"},"Method":{"description":"The http method type","type":"string"}}},"BaseCompanyModel":{"description":"The search code for the ApplicationCompany storage object.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"ShortName":{"description":"The unique identifier assigned to the client","type":"string"},"CompanyName":{"description":"Company name","type":"string"},"MarketingCompanyName":{"description":"Company Marketing Name","type":"string"},"CompanyRegistration":{"description":"Company registration number","type":"string"}}},"BaseCustomField":{"type":"object","properties":{"CustomFields":{"description":"Dynamic Custom Field:-","type":"array","items":{"$ref":"#/definitions/CustomFieldDataModel"}}}},"CustomFieldDataModel":{"type":"object","properties":{"ID":{"description":"Field ID:-","type":"string"},"TabName":{"description":"Tab on OS custom field belongs to:-","type":"string"},"GroupName":{"description":"The grouping on OS the custom field belongs to:-","type":"string"},"FieldName":{"description":"Name of the custom field:-","type":"string"},"Retired":{"description":"Is field retired:-","type":"boolean"},"Value":{"description":"Custom Field Value:-","type":"object"}}},"BaseCustomFieldSubmissionModel":{"type":"object","properties":{"customfieldValue":{"description":"Custom Field Value","type":"string"}}},"LeadPersonSubmissionModel":{"description":"Property Management Lead Person Submission Model:-","type":"object","properties":{"Branch":{"description":"Branch OID:-","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"Email":{"description":"Email","type":"string"},"MovingReason":{"description":"Moving Reason","type":"string"},"GlobalReference":{"description":"Property Global Reference","type":"string"},"Bedrooms":{"format":"int32","description":"Bedrooms","type":"integer"},"Postcode":{"description":"Postcode","type":"string"},"Price":{"format":"int32","description":"Price","type":"integer"},"ProtectedDate":{"description":"Protected Data","type":"boolean"},"FinanceAdvice":{"description":"Finance Advice","type":"boolean"},"PartExchange":{"description":"Part Exchange","type":"boolean"},"MovingMonth":{"description":"Rightmove Lead Person Moving Month","enum":["ASAP","January","February","March","April","May","June","July","August","September","October","November","December"],"type":"string"},"Comment":{"description":"Comment","type":"string"}}},"LeadsTypeModelResults":{"description":"Leads Type Model Results:-","type":"object","properties":{"Data":{"description":"Data:-","type":"array","items":{"$ref":"#/definitions/LeadsTypeModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"LeadsTypeModel":{"description":"Leads Type Model:-","type":"object","properties":{"OID":{"description":"The unique lead types ID:-","type":"string"},"ETag":{"description":"The Lead Types ETag:-","type":"string","readOnly":true},"Name":{"description":"The Lead Types Display Name:-","type":"string"}}},"BasePortalMediaSubmissionModel":{"description":"Portal Media Submission Model:-","type":"object","properties":{"InternalDocuments":{"description":"Documents to upload to the portal media (optional either this or external documents):-","type":"array","items":{"$ref":"#/definitions/BaseInternalDocumentSubmissionModel"}},"ExternalDocuments":{"description":"Documents to link from external URLs to the portal media (optional either this or internal documents):-","type":"array","items":{"$ref":"#/definitions/BaseExternalDocumentsSubmissionModel"}},"PortalMediaTypeID":{"description":"Portal Media Type:-","type":"string"},"MediaCaption":{"description":"Media Caption:-","type":"string"},"MediaSortOrder":{"format":"int32","description":"Sort order of media (optional)","type":"integer"},"MediaUrl":{"description":"Media Url:-","type":"string"}}},"BaseInternalDocumentSubmissionModel":{"description":"Base Document Submission Model:-","type":"object","properties":{"DocumentName":{"description":"The document to create name:-","type":"string"},"MimeType":{"description":"The document to create's MIME type:-","type":"string"},"Content":{"description":"The document to create's content:-","type":"string"}}},"BaseExternalDocumentsSubmissionModel":{"description":"External Documents Submission Model:-","type":"object","properties":{"URL":{"description":"Url of document:-","type":"string"}}},"BaseSystemTypeModelResults":{"description":"Base System Type Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/BaseSystemTypeModel"},"readOnly":true},"Count":{"format":"int32","description":"Results Count:-","type":"integer","readOnly":true},"Links":{"description":"Results Link:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"},"readOnly":true}}},"BaseSystemTypeModel":{"description":"Base System Type Model:-","type":"object","properties":{"OID":{"description":"Type ID:-","type":"string"},"Name":{"description":"Type Name:-","type":"string"}}},"BasePhotoUploadSubmissionModel":{"description":"Base Photo Upload Submission Model:-","type":"object","properties":{"Name":{"description":"User friendly name of photo:-","type":"string"},"FileName":{"description":"File name of photo, including file extension:-","type":"string"},"Content":{"description":"Base64 photo content string:-","type":"string"}}},"AdvertisingPhotoModelResults":{"description":"Holds results from a paged query returning PhotoModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingPhotoModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPhotoModel":{"description":"Stores a photo related to a property structure.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The photo name.","type":"string"},"PhotoNumber":{"format":"int32","description":"The photo ordering number","type":"integer"},"PhotoType":{"description":"The photo type","enum":["Photo","Map","FloorPlan","SiteMap","AerialPhoto","StreetView","FloodMap"],"type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPortalMediaResults":{"description":"Advertising Portal Media Results Model","type":"object","properties":{"Data":{"description":"Result Data","type":"array","items":{"$ref":"#/definitions/AdvertisingPortalMedia"}},"Count":{"format":"int32","description":"Result Count","type":"integer"},"Links":{"description":"HypermediaLinks","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingPortalMedia":{"description":"Advertising Portal Media:-","type":"object","properties":{"OID":{"description":"Portal Media OID:-","type":"string"},"MediaType":{"description":"Portal Media Type:-","type":"string"},"MediaSource":{"description":"Portal Media Source:-","type":"string"},"FileName":{"description":"Portal Media File Name:-","type":"string"},"MediaCaption":{"description":"Portal Media Caption :-","type":"string"},"URL":{"description":"Portal Media URL:-","type":"string"},"IsArchived":{"description":"Is Portal Media Item Archived:-","type":"boolean"},"Documents":{"description":"Portal Media Documents Model:-","type":"array","items":{"$ref":"#/definitions/PortalMediaDocuments"}}}},"PortalMediaDocuments":{"type":"object","properties":{"OID":{"description":"Document ID:-","type":"string"},"Name":{"description":"Document Name:-","type":"string"},"Note":{"description":"Document Note:-","type":"string"},"Type":{"description":"Document Type:-","type":"string"},"IsPublic":{"description":"Is Document Public?:-","type":"boolean"},"IsExternal":{"description":"Is Document External:-","type":"boolean"},"UploadedDate":{"format":"date-time","description":"Document Uploaded Date:-","type":"string"},"BelongsTo":{"description":"Document Belongs To:-","type":"string"},"IsArchived":{"description":"Is Document Archived:-","type":"boolean"},"URL":{"description":"Document URL:-","type":"string"}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}