POST Sync/getinitialentities

Get Initial Data.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
token	API access token	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "token": "542efd63-29b3-4287-81cd-ea91a83b4851"
}

application/xml, text/xml

Sample:

<AuthenticatedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">
  <token>542efd63-29b3-4287-81cd-ea91a83b4851</token>
</AuthenticatedRequest>

Response Information

Resource Description

GetInitialEntitiesResponse

Name	Description	Type	Additional information
Makes	Makes list	MakesList	None.
Years	Years list	YearsList	None.
Models	Models list	ModelsList	None.
Trims	Trims list	TrimsList	None.
ActivityActions	Activity Actions list	ActivityActionsList	None.
ActivityTypes	Activity Types list	ActivityTypesList	None.
ActivityStatuses	Activity Statuses list	ActivityStatusesList	None.
ActivityResults	Activity Results list	ActivityResultsList	None.
code	API result code	integer	None.
error	API error message	string	None.
APIVersion	API Version	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "APIVersion": 1,
  "Makes": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "Makes": [
      {
        "CountryID": 1,
        "MakeID": 2,
        "MakeName": "sample string 3",
        "TrimFormat": "sample string 4",
        "Kind": "sample string 5"
      },
      {
        "CountryID": 1,
        "MakeID": 2,
        "MakeName": "sample string 3",
        "TrimFormat": "sample string 4",
        "Kind": "sample string 5"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "Years": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "Years": [
      {
        "YearID": 1,
        "Kind": "sample string 2"
      },
      {
        "YearID": 1,
        "Kind": "sample string 2"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "Models": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "Models": [
      {
        "ModelID": 1,
        "YearID": 2,
        "MakeID": 3,
        "ModelName": "sample string 4",
        "Kind": "sample string 5"
      },
      {
        "ModelID": 1,
        "YearID": 2,
        "MakeID": 3,
        "ModelName": "sample string 4",
        "Kind": "sample string 5"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "Trims": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "Trims": [
      {
        "TrimID": 1,
        "ModelID": 2,
        "TrimName": "sample string 3",
        "Kind": "sample string 4"
      },
      {
        "TrimID": 1,
        "ModelID": 2,
        "TrimName": "sample string 3",
        "Kind": "sample string 4"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "ActivityActions": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "ActivityActions": [
      {
        "ActivityActionID": 1,
        "ActivityActionName": "sample string 2",
        "ActivityActionShort": "sample string 3",
        "ActivityTypeID": 4,
        "ActivityStatusID": 5,
        "ResultSetID": 6,
        "Kind": "sample string 7"
      },
      {
        "ActivityActionID": 1,
        "ActivityActionName": "sample string 2",
        "ActivityActionShort": "sample string 3",
        "ActivityTypeID": 4,
        "ActivityStatusID": 5,
        "ResultSetID": 6,
        "Kind": "sample string 7"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "ActivityTypes": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "ActivityTypes": [
      {
        "ActivityTypeID": 1,
        "ActivityTypeName": "sample string 2",
        "Kind": "sample string 3"
      },
      {
        "ActivityTypeID": 1,
        "ActivityTypeName": "sample string 2",
        "Kind": "sample string 3"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "ActivityStatuses": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "ActivityStatuses": [
      {
        "ActivityStatusID": 1,
        "ActivityStatusName": "sample string 2",
        "Kind": "sample string 3"
      },
      {
        "ActivityStatusID": 1,
        "ActivityStatusName": "sample string 2",
        "Kind": "sample string 3"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "ActivityResults": {
    "VersionID": 1,
    "ExpirationInDays": 2,
    "APIVersion": 3,
    "ActivityResults": [
      {
        "ActivityResultID": 1,
        "ActivityResultSetID": 2,
        "ActivityResultPriority": 3,
        "ActivityResultName": "sample string 4",
        "Kind": "sample string 5"
      },
      {
        "ActivityResultID": 1,
        "ActivityResultSetID": 2,
        "ActivityResultPriority": 3,
        "ActivityResultName": "sample string 4",
        "Kind": "sample string 5"
      }
    ],
    "code": 200,
    "error": "sample string 1"
  },
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:

<GetInitialEntitiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Sync">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <ActivityActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:ActivityActions>
      <d2p1:ActivityAction>
        <d2p1:Kind>sample string 7</d2p1:Kind>
        <d2p1:ActivityActionID>1</d2p1:ActivityActionID>
        <d2p1:ActivityActionName>sample string 2</d2p1:ActivityActionName>
        <d2p1:ActivityActionShort>sample string 3</d2p1:ActivityActionShort>
        <d2p1:ActivityStatusID>5</d2p1:ActivityStatusID>
        <d2p1:ActivityTypeID>4</d2p1:ActivityTypeID>
        <d2p1:ResultSetID>6</d2p1:ResultSetID>
      </d2p1:ActivityAction>
      <d2p1:ActivityAction>
        <d2p1:Kind>sample string 7</d2p1:Kind>
        <d2p1:ActivityActionID>1</d2p1:ActivityActionID>
        <d2p1:ActivityActionName>sample string 2</d2p1:ActivityActionName>
        <d2p1:ActivityActionShort>sample string 3</d2p1:ActivityActionShort>
        <d2p1:ActivityStatusID>5</d2p1:ActivityStatusID>
        <d2p1:ActivityTypeID>4</d2p1:ActivityTypeID>
        <d2p1:ResultSetID>6</d2p1:ResultSetID>
      </d2p1:ActivityAction>
    </d2p1:ActivityActions>
  </ActivityActions>
  <ActivityResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:ActivityResults>
      <d2p1:ActivityResult>
        <d2p1:Kind>sample string 5</d2p1:Kind>
        <d2p1:ActivityResultID>1</d2p1:ActivityResultID>
        <d2p1:ActivityResultName>sample string 4</d2p1:ActivityResultName>
        <d2p1:ActivityResultPriority>3</d2p1:ActivityResultPriority>
        <d2p1:ActivityResultSetID>2</d2p1:ActivityResultSetID>
      </d2p1:ActivityResult>
      <d2p1:ActivityResult>
        <d2p1:Kind>sample string 5</d2p1:Kind>
        <d2p1:ActivityResultID>1</d2p1:ActivityResultID>
        <d2p1:ActivityResultName>sample string 4</d2p1:ActivityResultName>
        <d2p1:ActivityResultPriority>3</d2p1:ActivityResultPriority>
        <d2p1:ActivityResultSetID>2</d2p1:ActivityResultSetID>
      </d2p1:ActivityResult>
    </d2p1:ActivityResults>
  </ActivityResults>
  <ActivityStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:ActivityStatuses>
      <d2p1:ActivityStatus>
        <d2p1:Kind>sample string 3</d2p1:Kind>
        <d2p1:ActivityStatusID>1</d2p1:ActivityStatusID>
        <d2p1:ActivityStatusName>sample string 2</d2p1:ActivityStatusName>
      </d2p1:ActivityStatus>
      <d2p1:ActivityStatus>
        <d2p1:Kind>sample string 3</d2p1:Kind>
        <d2p1:ActivityStatusID>1</d2p1:ActivityStatusID>
        <d2p1:ActivityStatusName>sample string 2</d2p1:ActivityStatusName>
      </d2p1:ActivityStatus>
    </d2p1:ActivityStatuses>
  </ActivityStatuses>
  <ActivityTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:ActivityTypes>
      <d2p1:ActivityType>
        <d2p1:Kind>sample string 3</d2p1:Kind>
        <d2p1:ActivityTypeID>1</d2p1:ActivityTypeID>
        <d2p1:ActivityTypeName>sample string 2</d2p1:ActivityTypeName>
      </d2p1:ActivityType>
      <d2p1:ActivityType>
        <d2p1:Kind>sample string 3</d2p1:Kind>
        <d2p1:ActivityTypeID>1</d2p1:ActivityTypeID>
        <d2p1:ActivityTypeName>sample string 2</d2p1:ActivityTypeName>
      </d2p1:ActivityType>
    </d2p1:ActivityTypes>
  </ActivityTypes>
  <Makes xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:Makes>
      <d2p1:Make>
        <d2p1:Kind>sample string 5</d2p1:Kind>
        <d2p1:CountryID>1</d2p1:CountryID>
        <d2p1:MakeID>2</d2p1:MakeID>
        <d2p1:MakeName>sample string 3</d2p1:MakeName>
        <d2p1:TrimFormat>sample string 4</d2p1:TrimFormat>
      </d2p1:Make>
      <d2p1:Make>
        <d2p1:Kind>sample string 5</d2p1:Kind>
        <d2p1:CountryID>1</d2p1:CountryID>
        <d2p1:MakeID>2</d2p1:MakeID>
        <d2p1:MakeName>sample string 3</d2p1:MakeName>
        <d2p1:TrimFormat>sample string 4</d2p1:TrimFormat>
      </d2p1:Make>
    </d2p1:Makes>
  </Makes>
  <Models xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:Models>
      <d2p1:Model>
        <d2p1:Kind>sample string 5</d2p1:Kind>
        <d2p1:MakeID>3</d2p1:MakeID>
        <d2p1:ModelID>1</d2p1:ModelID>
        <d2p1:ModelName>sample string 4</d2p1:ModelName>
        <d2p1:YearID>2</d2p1:YearID>
      </d2p1:Model>
      <d2p1:Model>
        <d2p1:Kind>sample string 5</d2p1:Kind>
        <d2p1:MakeID>3</d2p1:MakeID>
        <d2p1:ModelID>1</d2p1:ModelID>
        <d2p1:ModelName>sample string 4</d2p1:ModelName>
        <d2p1:YearID>2</d2p1:YearID>
      </d2p1:Model>
    </d2p1:Models>
  </Models>
  <Trims xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:Trims>
      <d2p1:Trim>
        <d2p1:Kind>sample string 4</d2p1:Kind>
        <d2p1:ModelID>2</d2p1:ModelID>
        <d2p1:TrimID>1</d2p1:TrimID>
        <d2p1:TrimName>sample string 3</d2p1:TrimName>
      </d2p1:Trim>
      <d2p1:Trim>
        <d2p1:Kind>sample string 4</d2p1:Kind>
        <d2p1:ModelID>2</d2p1:ModelID>
        <d2p1:TrimID>1</d2p1:TrimID>
        <d2p1:TrimName>sample string 3</d2p1:TrimName>
      </d2p1:Trim>
    </d2p1:Trims>
  </Trims>
  <Years xmlns:d2p1="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
    <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">3</APIVersion>
    <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
    <d2p1:ExpirationInDays>2</d2p1:ExpirationInDays>
    <d2p1:VersionID>1</d2p1:VersionID>
    <d2p1:Years>
      <d2p1:Year>
        <d2p1:Kind>sample string 2</d2p1:Kind>
        <d2p1:YearID>1</d2p1:YearID>
      </d2p1:Year>
      <d2p1:Year>
        <d2p1:Kind>sample string 2</d2p1:Kind>
        <d2p1:YearID>1</d2p1:YearID>
      </d2p1:Year>
    </d2p1:Years>
  </Years>
</GetInitialEntitiesResponse>