{"swagger":"2.0","info":{"version":"v4-notes","title":"agentOS API V4, Notes Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/notes/{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/notes/{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/notes/{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/notes/{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/notes/{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/notes/{shortName}/notes/{objectID}/object/{offset}/{count}":{"get":{"tags":["NotesController"],"summary":"Get notes for an object:-","operationId":"NotesController_GetObjectNotes","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":"startDate","in":"query","description":"The search from date","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The search to date","required":true,"type":"string","format":"date-time"},{"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/NotesModelResults"}}}}},"/v4/notes/{shortName}/notes/{personID}/person":{"post":{"tags":["NotesController"],"summary":"Create new note for a person:-","operationId":"NotesController_CreateObjectNote","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":"personID","in":"path","description":"The Unique Person ID","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"The create person submission model","required":true,"schema":{"$ref":"#/definitions/ObjectNoteSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/notes/{shortName}/notes/types/{offset}/{count}":{"get":{"tags":["NotesController"],"summary":"Retrieve all note types:-","operationId":"NotesController_GetCertificateTypes","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 number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NoteTypeModelResults"}}}}}},"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"}}},"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"}}},"ObjectNoteSubmissionModel":{"description":"Object Notes Submission Model:-","type":"object","properties":{"Content":{"description":"Note Content:-","type":"string"},"noteTypeID":{"description":"Note Type OID:-","type":"string"}}},"NotesModelResults":{"type":"object","properties":{"Notes":{"description":"An dynamic array of notes corresponding to the object returning.","type":"object"},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"NoteTypeModelResults":{"description":"Note Type Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/NoteTypeModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"NoteTypeModel":{"type":"object","properties":{"OID":{"description":"The Note Type OID:-","type":"string","readOnly":true},"Name":{"description":"The Note Type Name:-","type":"string","readOnly":true}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}