GET api/v1/cases/by-case-number/{caseNumber}

Get a Case object. Contains information about a case, as well as a Customer object, a ContactInformation object and a list of tasks to perform for the case.

Request Information

URI Parameters

Name	Description	Type	Additional information
caseNumber	Case number of the case to return	string	Required

Body Parameters

None.

Response Information

Resource Description

CaseDto

Name	Type	Additional information
Id	integer	None.
ParentCaseId	integer	None.
LastUpdated	date	None.
CreatedDate	date	None.
StartDate	date	None.
DeliveryDate	date	None.
ExternalNumber	string	None.
CustomerId	integer	None.
CustomerName	string	None.
Title	string	None.
Description	string	None.
EntityName	string	None.
CustomerEmail	string	None.
CustomerPhone	string	None.
IsCompleted	boolean	None.
CanBeReopened	boolean	None.
CaseUserBindings	Collection of integer	None.
Project	ProjectSimpleDto	None.
CaseAddress	AddressDto	None.
CustomerAddress	AddressDto	None.
CustomerContactPerson	ContactInformationDto	None.
AdditionalCustomerContactPersons	Collection of ContactInformationDto	None.
CheckList	Collection of string	None.
Files	Collection of FileDto	None.
Documents	Collection of DocumentSimpleDto	None.
Images	Collection of ImageDto	None.
ImageGroups	Collection of ImageGroupSimpleDto	None.
ProductRegistrations	Collection of ProductRegistrationDto	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "parentCaseId": 2,
  "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
  "createdDate": "2025-12-08T10:16:45.4053125+01:00",
  "startDate": "2025-12-08T10:16:45.4053125+01:00",
  "deliveryDate": "2025-12-08T10:16:45.4053125+01:00",
  "externalNumber": "sample string 5",
  "customerId": 1,
  "customerName": "sample string 6",
  "title": "sample string 7",
  "description": "sample string 8",
  "entityName": "sample string 9",
  "customerEmail": "sample string 10",
  "customerPhone": "sample string 11",
  "isCompleted": true,
  "canBeReopened": true,
  "caseUserBindings": [
    1,
    2
  ],
  "project": {
    "id": 1,
    "number": 2,
    "title": "sample string 3",
    "parentProjectId": 1,
    "isTemplate": true,
    "countryId": 1,
    "projectTypeId": 5,
    "projectStatusId": 6
  },
  "caseAddress": {
    "addressId": 1,
    "name": "sample string 2",
    "address1": "sample string 3",
    "address2": "sample string 4",
    "zipCode": "sample string 5",
    "city": "sample string 6",
    "country": "sample string 7",
    "countryId": 1,
    "attention": "sample string 8"
  },
  "customerAddress": {
    "addressId": 1,
    "name": "sample string 2",
    "address1": "sample string 3",
    "address2": "sample string 4",
    "zipCode": "sample string 5",
    "city": "sample string 6",
    "country": "sample string 7",
    "countryId": 1,
    "attention": "sample string 8"
  },
  "customerContactPerson": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phoneNumber": "sample string 3",
    "position": "sample string 4",
    "company": "sample string 5"
  },
  "additionalCustomerContactPersons": [
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "phoneNumber": "sample string 3",
      "position": "sample string 4",
      "company": "sample string 5"
    },
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "phoneNumber": "sample string 3",
      "position": "sample string 4",
      "company": "sample string 5"
    }
  ],
  "checkList": [
    "sample string 1",
    "sample string 2"
  ],
  "files": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "binaryData": "sample string 4",
      "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
      "pages": 1,
      "fileTypeName": "sample string 5",
      "fileTypeExtension": "sample string 6",
      "bytes": 1,
      "preloadInApp": true,
      "showInClient": true,
      "groupName": "sample string 9"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "binaryData": "sample string 4",
      "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
      "pages": 1,
      "fileTypeName": "sample string 5",
      "fileTypeExtension": "sample string 6",
      "bytes": 1,
      "preloadInApp": true,
      "showInClient": true,
      "groupName": "sample string 9"
    }
  ],
  "documents": [
    {
      "documentId": 1,
      "wP_CustomerId": 2,
      "userId": 3,
      "templateId": 4,
      "title": "sample string 5",
      "description": "sample string 6",
      "pages": 1,
      "timeCreated": "2025-12-08T10:16:45.4053125+01:00",
      "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
      "imageCount": 9
    },
    {
      "documentId": 1,
      "wP_CustomerId": 2,
      "userId": 3,
      "templateId": 4,
      "title": "sample string 5",
      "description": "sample string 6",
      "pages": 1,
      "timeCreated": "2025-12-08T10:16:45.4053125+01:00",
      "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
      "imageCount": 9
    }
  ],
  "images": [
    {
      "imageId": 1,
      "userId": 2,
      "caseId": 1,
      "encodedImage": "sample string 3",
      "encodedThumbnail": "sample string 4",
      "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
      "latitude": 1.1,
      "longitude": 1.1,
      "height": 1,
      "width": 1,
      "name": "sample string 5",
      "description": "sample string 6",
      "groupName": "sample string 7"
    },
    {
      "imageId": 1,
      "userId": 2,
      "caseId": 1,
      "encodedImage": "sample string 3",
      "encodedThumbnail": "sample string 4",
      "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
      "latitude": 1.1,
      "longitude": 1.1,
      "height": 1,
      "width": 1,
      "name": "sample string 5",
      "description": "sample string 6",
      "groupName": "sample string 7"
    }
  ],
  "imageGroups": [
    {
      "imageGroupId": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "images": [
        {
          "imageId": 1,
          "userId": 2,
          "caseId": 1,
          "encodedImage": "sample string 3",
          "encodedThumbnail": "sample string 4",
          "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
          "latitude": 1.1,
          "longitude": 1.1,
          "height": 1,
          "width": 1,
          "name": "sample string 5",
          "description": "sample string 6",
          "groupName": "sample string 7"
        },
        {
          "imageId": 1,
          "userId": 2,
          "caseId": 1,
          "encodedImage": "sample string 3",
          "encodedThumbnail": "sample string 4",
          "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
          "latitude": 1.1,
          "longitude": 1.1,
          "height": 1,
          "width": 1,
          "name": "sample string 5",
          "description": "sample string 6",
          "groupName": "sample string 7"
        }
      ]
    },
    {
      "imageGroupId": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "images": [
        {
          "imageId": 1,
          "userId": 2,
          "caseId": 1,
          "encodedImage": "sample string 3",
          "encodedThumbnail": "sample string 4",
          "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
          "latitude": 1.1,
          "longitude": 1.1,
          "height": 1,
          "width": 1,
          "name": "sample string 5",
          "description": "sample string 6",
          "groupName": "sample string 7"
        },
        {
          "imageId": 1,
          "userId": 2,
          "caseId": 1,
          "encodedImage": "sample string 3",
          "encodedThumbnail": "sample string 4",
          "lastUpdated": "2025-12-08T10:16:45.4053125+01:00",
          "latitude": 1.1,
          "longitude": 1.1,
          "height": 1,
          "width": 1,
          "name": "sample string 5",
          "description": "sample string 6",
          "groupName": "sample string 7"
        }
      ]
    }
  ],
  "productRegistrations": [
    {
      "id": 1,
      "userId": 2,
      "caseId": 3,
      "productId": 4,
      "productName": "sample string 5",
      "timestamp": "2025-12-08T10:16:45.4053125+01:00",
      "quantity": 6.0,
      "isCreditRegistration": true,
      "productSalePrice": 1.0,
      "ean": "sample string 8"
    },
    {
      "id": 1,
      "userId": 2,
      "caseId": 3,
      "productId": 4,
      "productName": "sample string 5",
      "timestamp": "2025-12-08T10:16:45.4053125+01:00",
      "quantity": 6.0,
      "isCreditRegistration": true,
      "productSalePrice": 1.0,
      "ean": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<CaseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
  <AdditionalCustomerContactPersons>
    <ContactInformationDto>
      <Company>sample string 5</Company>
      <Email>sample string 2</Email>
      <Name>sample string 1</Name>
      <PhoneNumber>sample string 3</PhoneNumber>
      <Position>sample string 4</Position>
    </ContactInformationDto>
    <ContactInformationDto>
      <Company>sample string 5</Company>
      <Email>sample string 2</Email>
      <Name>sample string 1</Name>
      <PhoneNumber>sample string 3</PhoneNumber>
      <Position>sample string 4</Position>
    </ContactInformationDto>
  </AdditionalCustomerContactPersons>
  <CanBeReopened>true</CanBeReopened>
  <CaseAddress>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <AddressId>1</AddressId>
    <Attention>sample string 8</Attention>
    <City>sample string 6</City>
    <Country>sample string 7</Country>
    <CountryId>1</CountryId>
    <Name>sample string 2</Name>
    <ZipCode>sample string 5</ZipCode>
  </CaseAddress>
  <CaseUserBindings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CaseUserBindings>
  <CheckList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CheckList>
  <CreatedDate>2025-12-08T10:16:45.4053125+01:00</CreatedDate>
  <CustomerAddress>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <AddressId>1</AddressId>
    <Attention>sample string 8</Attention>
    <City>sample string 6</City>
    <Country>sample string 7</Country>
    <CountryId>1</CountryId>
    <Name>sample string 2</Name>
    <ZipCode>sample string 5</ZipCode>
  </CustomerAddress>
  <CustomerContactPerson>
    <Company>sample string 5</Company>
    <Email>sample string 2</Email>
    <Name>sample string 1</Name>
    <PhoneNumber>sample string 3</PhoneNumber>
    <Position>sample string 4</Position>
  </CustomerContactPerson>
  <CustomerEmail>sample string 10</CustomerEmail>
  <CustomerId>1</CustomerId>
  <CustomerName>sample string 6</CustomerName>
  <CustomerPhone>sample string 11</CustomerPhone>
  <DeliveryDate>2025-12-08T10:16:45.4053125+01:00</DeliveryDate>
  <Description>sample string 8</Description>
  <Documents>
    <DocumentSimpleDto>
      <Description>sample string 6</Description>
      <DocumentId>1</DocumentId>
      <ImageCount>9</ImageCount>
      <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
      <Pages>1</Pages>
      <TemplateId>4</TemplateId>
      <TimeCreated>2025-12-08T10:16:45.4053125+01:00</TimeCreated>
      <Title>sample string 5</Title>
      <UserId>3</UserId>
      <WP_CustomerId>2</WP_CustomerId>
    </DocumentSimpleDto>
    <DocumentSimpleDto>
      <Description>sample string 6</Description>
      <DocumentId>1</DocumentId>
      <ImageCount>9</ImageCount>
      <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
      <Pages>1</Pages>
      <TemplateId>4</TemplateId>
      <TimeCreated>2025-12-08T10:16:45.4053125+01:00</TimeCreated>
      <Title>sample string 5</Title>
      <UserId>3</UserId>
      <WP_CustomerId>2</WP_CustomerId>
    </DocumentSimpleDto>
  </Documents>
  <EntityName>sample string 9</EntityName>
  <ExternalNumber>sample string 5</ExternalNumber>
  <Files>
    <FileDto>
      <BinaryData>sample string 4</BinaryData>
      <Bytes>1</Bytes>
      <Description>sample string 3</Description>
      <FileTypeExtension>sample string 6</FileTypeExtension>
      <FileTypeName>sample string 5</FileTypeName>
      <GroupName>sample string 9</GroupName>
      <Id>1</Id>
      <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
      <Name>sample string 2</Name>
      <Pages>1</Pages>
      <PreloadInApp>true</PreloadInApp>
      <ShowInClient>true</ShowInClient>
    </FileDto>
    <FileDto>
      <BinaryData>sample string 4</BinaryData>
      <Bytes>1</Bytes>
      <Description>sample string 3</Description>
      <FileTypeExtension>sample string 6</FileTypeExtension>
      <FileTypeName>sample string 5</FileTypeName>
      <GroupName>sample string 9</GroupName>
      <Id>1</Id>
      <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
      <Name>sample string 2</Name>
      <Pages>1</Pages>
      <PreloadInApp>true</PreloadInApp>
      <ShowInClient>true</ShowInClient>
    </FileDto>
  </Files>
  <Id>1</Id>
  <ImageGroups>
    <ImageGroupSimpleDto>
      <Description>sample string 3</Description>
      <ImageGroupId>1</ImageGroupId>
      <Images>
        <ImageDto>
          <CaseId>1</CaseId>
          <Description>sample string 6</Description>
          <EncodedImage>sample string 3</EncodedImage>
          <EncodedThumbnail>sample string 4</EncodedThumbnail>
          <GroupName>sample string 7</GroupName>
          <Height>1</Height>
          <ImageId>1</ImageId>
          <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Name>sample string 5</Name>
          <UserId>2</UserId>
          <Width>1</Width>
        </ImageDto>
        <ImageDto>
          <CaseId>1</CaseId>
          <Description>sample string 6</Description>
          <EncodedImage>sample string 3</EncodedImage>
          <EncodedThumbnail>sample string 4</EncodedThumbnail>
          <GroupName>sample string 7</GroupName>
          <Height>1</Height>
          <ImageId>1</ImageId>
          <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Name>sample string 5</Name>
          <UserId>2</UserId>
          <Width>1</Width>
        </ImageDto>
      </Images>
      <Name>sample string 2</Name>
    </ImageGroupSimpleDto>
    <ImageGroupSimpleDto>
      <Description>sample string 3</Description>
      <ImageGroupId>1</ImageGroupId>
      <Images>
        <ImageDto>
          <CaseId>1</CaseId>
          <Description>sample string 6</Description>
          <EncodedImage>sample string 3</EncodedImage>
          <EncodedThumbnail>sample string 4</EncodedThumbnail>
          <GroupName>sample string 7</GroupName>
          <Height>1</Height>
          <ImageId>1</ImageId>
          <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Name>sample string 5</Name>
          <UserId>2</UserId>
          <Width>1</Width>
        </ImageDto>
        <ImageDto>
          <CaseId>1</CaseId>
          <Description>sample string 6</Description>
          <EncodedImage>sample string 3</EncodedImage>
          <EncodedThumbnail>sample string 4</EncodedThumbnail>
          <GroupName>sample string 7</GroupName>
          <Height>1</Height>
          <ImageId>1</ImageId>
          <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Name>sample string 5</Name>
          <UserId>2</UserId>
          <Width>1</Width>
        </ImageDto>
      </Images>
      <Name>sample string 2</Name>
    </ImageGroupSimpleDto>
  </ImageGroups>
  <Images>
    <ImageDto>
      <CaseId>1</CaseId>
      <Description>sample string 6</Description>
      <EncodedImage>sample string 3</EncodedImage>
      <EncodedThumbnail>sample string 4</EncodedThumbnail>
      <GroupName>sample string 7</GroupName>
      <Height>1</Height>
      <ImageId>1</ImageId>
      <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Name>sample string 5</Name>
      <UserId>2</UserId>
      <Width>1</Width>
    </ImageDto>
    <ImageDto>
      <CaseId>1</CaseId>
      <Description>sample string 6</Description>
      <EncodedImage>sample string 3</EncodedImage>
      <EncodedThumbnail>sample string 4</EncodedThumbnail>
      <GroupName>sample string 7</GroupName>
      <Height>1</Height>
      <ImageId>1</ImageId>
      <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Name>sample string 5</Name>
      <UserId>2</UserId>
      <Width>1</Width>
    </ImageDto>
  </Images>
  <IsCompleted>true</IsCompleted>
  <LastUpdated>2025-12-08T10:16:45.4053125+01:00</LastUpdated>
  <ParentCaseId>2</ParentCaseId>
  <ProductRegistrations>
    <ProductRegistrationDto>
      <CaseId>3</CaseId>
      <Ean>sample string 8</Ean>
      <Id>1</Id>
      <IsCreditRegistration>true</IsCreditRegistration>
      <ProductId>4</ProductId>
      <ProductName>sample string 5</ProductName>
      <ProductSalePrice>1</ProductSalePrice>
      <Quantity>6</Quantity>
      <Timestamp>2025-12-08T10:16:45.4053125+01:00</Timestamp>
      <UserId>2</UserId>
    </ProductRegistrationDto>
    <ProductRegistrationDto>
      <CaseId>3</CaseId>
      <Ean>sample string 8</Ean>
      <Id>1</Id>
      <IsCreditRegistration>true</IsCreditRegistration>
      <ProductId>4</ProductId>
      <ProductName>sample string 5</ProductName>
      <ProductSalePrice>1</ProductSalePrice>
      <Quantity>6</Quantity>
      <Timestamp>2025-12-08T10:16:45.4053125+01:00</Timestamp>
      <UserId>2</UserId>
    </ProductRegistrationDto>
  </ProductRegistrations>
  <Project>
    <CountryId>1</CountryId>
    <Id>1</Id>
    <IsTemplate>true</IsTemplate>
    <Number>2</Number>
    <ParentProjectId>1</ParentProjectId>
    <ProjectStatusId>6</ProjectStatusId>
    <ProjectTypeId>5</ProjectTypeId>
    <Title>sample string 3</Title>
  </Project>
  <StartDate>2025-12-08T10:16:45.4053125+01:00</StartDate>
  <Title>sample string 7</Title>
</CaseDto>