GET api/Agency

Get details of the current users agency

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The Agency or null if it does not exist.

Dezrez.Core.DataContracts.External.Api.Agency.Query.Get.AgencyDataContract

Name	Type	Additional information
Name	string	None.
Branches	Collection of Dezrez.Core.DataContracts.External.Api.Branch.Query.Get.BranchReferenceDataContract	None.
Licenses	integer	None.
About	string	None.
SystemStatus	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
LegacyItemId	integer	None.
RegionId	integer	None.
CustomFields	Collection of Dezrez.Core.DataContracts.External.Api.Custom.Command.SaveCustomField.CustomFieldGroupWithValuesDataContract	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",
  "Branches": [
    {
      "Name": "sample string 1",
      "LegalEntityId": 2,
      "VAT": "sample string 3",
      "Id": 4
    },
    {
      "Name": "sample string 1",
      "LegalEntityId": 2,
      "VAT": "sample string 3",
      "Id": 4
    }
  ],
  "Licenses": 2,
  "About": "sample string 3",
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "LegacyItemId": 4,
  "RegionId": 5,
  "CustomFields": [
    {
      "Name": "sample string 1",
      "Values": [
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Values": [
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    }
  ],
  "CreatedDate": "2024-04-20T12:35:12.5875994Z",
  "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": 7
}