POST api/clients/start-up-data/get

Gets the data needed for client operations.

Request Information

URI Parameters

None.

Body Parameters

An object with the input parameters to be used during pulling of the data.

Name	Description	Type	Additional information
Since		date	None.

Request Formats

application/json, text/json

Sample:

{
  "Since": "2026-05-05T07:16:50.6881824-04:00"
}

application/xml, text/xml

Sample:

<GetClientStartUpDataInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs">
  <Since>2026-05-05T07:16:50.6881824-04:00</Since>
</GetClientStartUpDataInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetClientStartUpDataInput'.

Response Information

Resource Description

An Http response message with the following status codes: 200 = success (an objects is returned; this object contains all start up data needed for clients) 400 = bad request (the request is malformed or with invalid data), 500 = something went wrong (the request was not processed).

ClientStartUpData

Name	Type	Additional information
ContactTypes	Collection of UiContactType	None.
Agencies	Collection of UiAgency	None.
States	Collection of UiState	None.
RelationshipTypes	Collection of UiRelationshipType	None.
FileNames	Collection of FileNameInfo	None.
ClientGeoAreas	Collection of UiClientGeoArea	None.

Response Formats

application/json, text/json

Sample:

{
  "ContactTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "DateUpdated": "2026-05-05T07:16:50.6881824-04:00",
      "UpdatedBy": 1,
      "Source": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "DateUpdated": "2026-05-05T07:16:50.6881824-04:00",
      "UpdatedBy": 1,
      "Source": "sample string 4"
    }
  ],
  "Agencies": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "DateUpdated": "2026-05-05T07:16:50.6881824-04:00"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "DateUpdated": "2026-05-05T07:16:50.6881824-04:00"
    }
  ],
  "States": [
    {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "RelationshipTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "ShowOnFamily": true,
      "ShowOnContacts": true,
      "ExportCode": "sample string 5",
      "ExternalId": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ShowOnFamily": true,
      "ShowOnContacts": true,
      "ExportCode": "sample string 5",
      "ExternalId": "sample string 6"
    }
  ],
  "FileNames": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "ClientGeoAreas": [
    {
      "clientId": 1,
      "geoAreaId": 1
    },
    {
      "clientId": 1,
      "geoAreaId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<ClientStartUpData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <Agencies>
    <UiAgency>
      <DateUpdated>2026-05-05T07:16:50.6881824-04:00</DateUpdated>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </UiAgency>
    <UiAgency>
      <DateUpdated>2026-05-05T07:16:50.6881824-04:00</DateUpdated>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </UiAgency>
  </Agencies>
  <ClientGeoAreas>
    <UiClientGeoArea>
      <clientId>1</clientId>
      <geoAreaId>1</geoAreaId>
    </UiClientGeoArea>
    <UiClientGeoArea>
      <clientId>1</clientId>
      <geoAreaId>1</geoAreaId>
    </UiClientGeoArea>
  </ClientGeoAreas>
  <ContactTypes>
    <UiContactType>
      <DateUpdated>2026-05-05T07:16:50.6881824-04:00</DateUpdated>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Source>sample string 4</Source>
      <UpdatedBy>1</UpdatedBy>
    </UiContactType>
    <UiContactType>
      <DateUpdated>2026-05-05T07:16:50.6881824-04:00</DateUpdated>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Source>sample string 4</Source>
      <UpdatedBy>1</UpdatedBy>
    </UiContactType>
  </ContactTypes>
  <FileNames xmlns:d2p1="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.Models">
    <d2p1:FileNameInfo>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:FileNameInfo>
    <d2p1:FileNameInfo>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:FileNameInfo>
  </FileNames>
  <RelationshipTypes>
    <UiRelationshipType>
      <ExportCode>sample string 5</ExportCode>
      <ExternalId>sample string 6</ExternalId>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <ShowOnContacts>true</ShowOnContacts>
      <ShowOnFamily>true</ShowOnFamily>
    </UiRelationshipType>
    <UiRelationshipType>
      <ExportCode>sample string 5</ExportCode>
      <ExternalId>sample string 6</ExternalId>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <ShowOnContacts>true</ShowOnContacts>
      <ShowOnFamily>true</ShowOnFamily>
    </UiRelationshipType>
  </RelationshipTypes>
  <States>
    <UiState>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </UiState>
    <UiState>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </UiState>
  </States>
</ClientStartUpData>