GET api/v1/subjects/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Subject

Name	Type	Additional information
id	globally unique identifier	Required
name	string	None.
subject_type	CodeListSystem	None.
address	Address	None.
contact	Contact	None.
registration_number	string	None.
vat_number	string	None.
account	string	None.
bank_code	string	None.
agreement	boolean	None.
broker	boolean	None.
deleted	boolean	Required
system_information	SystemInformation	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "c5e64d05-3efa-4080-9961-c81fd1defa9e",
  "name": "sample string 2",
  "subject_type": {
    "id": 1,
    "name": "sample string 2",
    "code": "sample string 3"
  },
  "address": {
    "custom_location": true,
    "region": "sample string 2",
    "district": "sample string 3",
    "city": "sample string 4",
    "country": "sample string 5",
    "street": "sample string 6",
    "description_number": "sample string 7",
    "house_number": "sample string 8",
    "county": "sample string 9",
    "postcode": "sample string 10",
    "location": {
      "lat": "sample string 1",
      "lng": "sample string 2"
    }
  },
  "contact": {
    "email": "sample string 1",
    "phone": "sample string 2",
    "person_first_name": "sample string 3",
    "person_last_name": "sample string 4"
  },
  "registration_number": "sample string 3",
  "vat_number": "sample string 4",
  "account": "sample string 5",
  "bank_code": "sample string 6",
  "agreement": true,
  "broker": true,
  "deleted": true,
  "system_information": {
    "creation": {
      "user": {
        "full_name": "sample string 12 sample string 11",
        "id": "8f25018d-50fc-4e3b-b0f2-082d2138fe55",
        "image_id": "d95690c9-be03-426e-a563-9e8c946dede4",
        "id_user_work_position": "eafafdbc-4566-4235-b074-184208b8dcd5",
        "id_shift": "5bd7998c-fc06-4707-ac66-748c12abf2d4",
        "code": "sample string 5",
        "code2": "sample string 6",
        "title": "sample string 9",
        "introduction": "sample string 10",
        "first_name": "sample string 11",
        "last_name": "sample string 12"
      },
      "date": "2024-07-27T07:01:58Z"
    },
    "last_change": {
      "user": {
        "full_name": "sample string 12 sample string 11",
        "id": "8f25018d-50fc-4e3b-b0f2-082d2138fe55",
        "image_id": "d95690c9-be03-426e-a563-9e8c946dede4",
        "id_user_work_position": "eafafdbc-4566-4235-b074-184208b8dcd5",
        "id_shift": "5bd7998c-fc06-4707-ac66-748c12abf2d4",
        "code": "sample string 5",
        "code2": "sample string 6",
        "title": "sample string 9",
        "introduction": "sample string 10",
        "first_name": "sample string 11",
        "last_name": "sample string 12"
      },
      "date": "2024-07-27T07:01:58Z"
    }
  }
}

application/xml, text/xml

Sample:

<Subject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <account>sample string 5</account>
  <address>
    <city>sample string 4</city>
    <country>sample string 5</country>
    <county>sample string 9</county>
    <custom_location>true</custom_location>
    <description_number>sample string 7</description_number>
    <district>sample string 3</district>
    <house_number>sample string 8</house_number>
    <location>
      <lat>sample string 1</lat>
      <lng>sample string 2</lng>
    </location>
    <postcode>sample string 10</postcode>
    <region>sample string 2</region>
    <street>sample string 6</street>
  </address>
  <agreement>true</agreement>
  <bank_code>sample string 6</bank_code>
  <broker>true</broker>
  <contact>
    <email>sample string 1</email>
    <person_first_name>sample string 3</person_first_name>
    <person_last_name>sample string 4</person_last_name>
    <phone>sample string 2</phone>
  </contact>
  <deleted>true</deleted>
  <id>c5e64d05-3efa-4080-9961-c81fd1defa9e</id>
  <name>sample string 2</name>
  <registration_number>sample string 3</registration_number>
  <subject_type>
    <code>sample string 3</code>
    <id>1</id>
    <name>sample string 2</name>
  </subject_type>
  <system_information>
    <creation>
      <date>2024-07-27T09:01:58.7825531+02:00</date>
      <user>
        <code>sample string 5</code>
        <code2>sample string 6</code2>
        <first_name>sample string 11</first_name>
        <full_name>sample string 12 sample string 11</full_name>
        <id>8f25018d-50fc-4e3b-b0f2-082d2138fe55</id>
        <id_shift>5bd7998c-fc06-4707-ac66-748c12abf2d4</id_shift>
        <id_user_work_position>eafafdbc-4566-4235-b074-184208b8dcd5</id_user_work_position>
        <image_id>d95690c9-be03-426e-a563-9e8c946dede4</image_id>
        <introduction>sample string 10</introduction>
        <last_name>sample string 12</last_name>
        <title>sample string 9</title>
      </user>
    </creation>
    <last_change>
      <date>2024-07-27T09:01:58.7825531+02:00</date>
      <user>
        <code>sample string 5</code>
        <code2>sample string 6</code2>
        <first_name>sample string 11</first_name>
        <full_name>sample string 12 sample string 11</full_name>
        <id>8f25018d-50fc-4e3b-b0f2-082d2138fe55</id>
        <id_shift>5bd7998c-fc06-4707-ac66-748c12abf2d4</id_shift>
        <id_user_work_position>eafafdbc-4566-4235-b074-184208b8dcd5</id_user_work_position>
        <image_id>d95690c9-be03-426e-a563-9e8c946dede4</image_id>
        <introduction>sample string 10</introduction>
        <last_name>sample string 12</last_name>
        <title>sample string 9</title>
      </user>
    </last_change>
  </system_information>
  <vat_number>sample string 4</vat_number>
</Subject>