GET api/agency/branches
Get the branches for an agency
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
A list of branches for the agency
Collection of Dezrez.Core.DataContracts.External.Api.Branch.Query.Get.BranchDataContractName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Description | string |
None. |
|
ContactDetails | Dezrez.Core.DataContracts.External.Api.People.Query.Get.ContactDetailsDataContract |
None. |
|
Agency | Dezrez.Core.DataContracts.External.Api.Agency.Query.Get.AgencyReferenceDataContract |
None. |
|
Responsibilities | Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
FeeLevelSetting | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
Members | Collection of Dezrez.Core.DataContracts.External.Api.Agency.Query.Teams.BranchTeamListMemberDataContract |
None. |
|
DefaultCulture | string |
None. |
|
VAT | string |
None. |
|
CreatedDate | date |
None. |
|
CreatedBy | Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Name": "sample string 1", "Description": "sample string 2", "ContactDetails": { "Addresses": [ { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "Location": { "CenterPoint": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Extent": [ { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 } ], "ViewPoints": [ { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 }, { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 } ], "Id": 1 }, "AddressSource": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SourceId": "sample string 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-10-08T08:00:59.878553Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 12 }, { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "Location": { "CenterPoint": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Extent": [ { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 } ], "ViewPoints": [ { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 }, { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 } ], "Id": 1 }, "AddressSource": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SourceId": "sample string 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-10-08T08:00:59.878553Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 12 } ], "ContactItems": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 } ], "Id": 1 }, "Agency": { "Name": "sample string 1", "Id": 2 }, "Responsibilities": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "FeeLevelSetting": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Members": [ { "JobTitle": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TeamRelationshipType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Note": "sample string 5", "ContactName": "sample string 6", "Id": 7 }, { "JobTitle": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TeamRelationshipType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Note": "sample string 5", "ContactName": "sample string 6", "Id": 7 } ], "DefaultCulture": "sample string 3", "VAT": "sample string 4", "CreatedDate": "2024-10-08T08:00:59.8941759Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 6 }, { "Name": "sample string 1", "Description": "sample string 2", "ContactDetails": { "Addresses": [ { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "Location": { "CenterPoint": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Extent": [ { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 } ], "ViewPoints": [ { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 }, { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 } ], "Id": 1 }, "AddressSource": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SourceId": "sample string 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-10-08T08:00:59.878553Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 12 }, { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "Location": { "CenterPoint": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Extent": [ { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 } ], "ViewPoints": [ { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 }, { "Point": { "Latitude": 1.1, "Longitude": 2.1, "Altitude": 3.1, "Order": 4, "Id": 5 }, "Pitch": 1.1, "Heading": 2.1, "FieldOfVision": 3.1, "Zoom": 4.1, "Label": "sample string 5", "Id": 6 } ], "Id": 1 }, "AddressSource": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SourceId": "sample string 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-10-08T08:00:59.878553Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 12 } ], "ContactItems": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 } ], "Id": 1 }, "Agency": { "Name": "sample string 1", "Id": 2 }, "Responsibilities": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "FeeLevelSetting": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Members": [ { "JobTitle": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TeamRelationshipType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Note": "sample string 5", "ContactName": "sample string 6", "Id": 7 }, { "JobTitle": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TeamRelationshipType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Note": "sample string 5", "ContactName": "sample string 6", "Id": 7 } ], "DefaultCulture": "sample string 3", "VAT": "sample string 4", "CreatedDate": "2024-10-08T08:00:59.8941759Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 6 } ]