다음을 통해 공유

TeamWherx

TW(TeamWherx)는 원격 직원 팀 및 일반 비즈니스 운영을 사무실에서 보다 효과적으로 관리하는 데 도움이 되는 올인원 서비스 관리 플랫폼입니다. 클라우드 기반 솔루션인 TW는 원격 데이터 수집을 가능하게 하고 웹앱 대시보드를 통해 표시하여 관리자에게 모바일 인력을 조정하면서 효율성, 생산성 및 비용 절감을 위한 보다 스마트한 전략을 만드는 데 필요한 추가 인사이트를 제공합니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 Regions
Copilot Studio Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
논리 앱 스탠다드 다음을 제외한 모든 Logic Apps 지역 :
     - Azure Government 지역
     - Azure 중국 지역
     - 미국 국방부(DoD)
Power Apps Premium 다음을 제외한 모든 Power Apps 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
Power Automate Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
연락처
이름 Actsoft 지원
URL https://www.actsoft.com/self-help-wizards
전자 메일 support@actsoft.com
커넥터 메타데이터
게시자 Actsoft
웹 사이트 https://actsoft.com
개인 정보 보호 정책 https://www.actsoft.com/privacy
카테고리 생산력

커넥터 설명:

TeamWherx를 사용하면 디지털 양식 정보, 직원 시간 유지 정보를 만들고 캡처하고 디스패치 시스템으로 작업 주문을 관리할 수 있습니다.

자세한 설명

TeamWherx 커넥터를 사용하면 사용자가 여러 플랫폼 간에 정보를 연결하고 교환할 수 있습니다. 데이터에 애니메이션을 적용하여 프로세스 흐름을 만들고, 다른 사내 애플리케이션을 구동하고, 강력한 분석을 알릴 수 있습니다. up-to실행 가능한 데이터에 액세스하여 매일, 매주 또는 매월 프로세스를 자동화하고 간소화합니다.

## 필수 구성 요소

이 커넥터를 사용하려면 다음이 필요합니다.

  • TeamWherx 계정

  • TeamWherx API 키

  • Microsoft Power Apps 또는 Power Automate 계획

## 자격 증명을 가져오는 방법

API 개발자 포털

커넥터에 액세스하려면 먼저 API 개발자 포털에 대한 사용자 이름 및 암호를 설치하고 고객 API를 구독해야 합니다.

  1. 애플리케이션 내부에서 관리>설정>API설정으로 이동합니다.

  2. 자격 증명 만들기를 선택합니다.

  3. 적절한 필드에 이름과 성을 입력합니다.

  4. 전자 메일 주소 필드에 전자 메일주소를 입력합니다.

  5. 저장 및 전자 메일 초대를 선택합니다. 그런 다음, 암호를 만드는 방법에 대한 지침은 전자 메일을 확인합니다.

  6. 초대 전자 메일 내에서 암호 선택을 클릭하면 암호를 만들 수 있는 대화 상자가 열립니다.

  7. 암호 저장을 선택합니다.

  8. 개발자 포털로 이동하려면 애플리케이션 내에서 관리>설정>으로이동하여개발자 포털로 이동합니다.

  9. 개발자 포털 내에서 제품을 선택한 다음, 고객API를 선택합니다.

  10. 구독을 선택합니다.

API 키

이제 등록된 API 사용자이므로 키라고 하는 영숫자 시퀀스가 생성되었습니다. API에서 데이터를 사용하려면 이 키가 필요합니다.

API 키를 찾으려면 다음을 수행합니다.

  1. 개발자 포털 메뉴에서 제품을 선택합니다. 라이선스에서 사용할 수 있는 API 제품이 표시됩니다.

  2. '이 제품에 대한 X 구독이 있습니다.'에서 고객 API 버전을 선택합니다.

  3. 구독의 기본 키 옆에 표시 를 선택합니다.

  4. 필드의 내용을 선택하고 마우스 오른쪽 단추를 클릭하고 복사를 선택합니다. 이제 키가 클립보드에 저장되고 붙여넣을 준비가 되었습니다.

## 커넥터 시작

  1. 내 흐름 새>흐름으로 이동한 다음, 자동화된 클라우드 흐름을 선택합니다.

  2. 자동화된 클라우드 흐름 빌드 대화 상자에서 수동으로 흐름 트리거 를 선택합니다.

  3. 흐름 이름을 지정하거나 시스템에서 자동으로 흐름을 생성하도록 합니다.

  4. 흐름을 검색하고 트리거를 선택합니다.

  5. 만들기를 선택합니다.

  6. 검색 필드에서 TeamWherx 커넥터를 검색하여 선택합니다.

  7. 커넥터를 사용하여 수행하려는 작업을 찾습니다.

시스템은 선택한 작업을 수행하는 데 필요한 모든 앱에 로그인하라는 메시지를 표시하고 이미 로그인한 앱을 건너뜁니다.

  1. 커넥터 필드에 새 커넥터의 이름을 입력합니다.

  2. 그런 다음, API 키를 입력합니다.

  3. 만들기를 선택합니다. 프로세스 흐름의 첫 번째 단계는 순서도에서 첫 번째 '상자'로 표시됩니다.

  4. 새단계를 선택하여 커넥터 프로세스 흐름에 더 많은 작업 및 단계를 계속 추가합니다.

  5. 저장을 선택합니다.

**커넥터 사용 - 주문 상태 폴링 예제
** 아래 지침에서는 워크시트에 행을 삽입하는 프로세스 흐름을 만들고 주문 상태가 업데이트되면 주문을 업데이트한 직원의 식별 데이터를 삽입하는 방법을 보여 줍니다.

  1. 커넥터로 이동합니다.

  2. [TeamWherx] 커넥터를 검색하여 선택합니다.

  3. 작업 목록에서 주문 상태 폴링 선택

  4. 연결 이름 필드에 새 연결의 이름을 입력합니다.

  5. 그런 다음, API 키를 입력합니다.

  6. 만들기를 선택합니다. 프로세스 흐름의 첫 번째 단계는 순서도에서 첫 번째 '상자'로 표시됩니다.

연결 흐름 단계의 각 작업 대화 상자에는 수행된 작업을 제어하기 위해 사용자 지정할 수 있는 속성 필드가 있습니다.

  1. 이 예제를 계속 진행하면서 Forms 필드 값을 표시할지 여부를 선택합니다(excludeFormData 매개 변수).

  2. 연결에 대한 X-API 버전을 선택합니다.

  3. 주문 상태가 변경될 때 수행하려는 작업을 설정하려면 다음 단계를 선택합니다.

  4. 작업 선택 대화 상자에서 검색 필드를 사용하여 애플리케이션을 찾은 다음 원하는 작업을 찾습니다. 예를 들어 주문 상태가 변경될 때마다 Google 워크시트에 행을 삽입하려는 경우 Google시트를 선택한 다음 작업에 행을 삽입합니다.

  5. 다음 행삽입 대화 상자에서 [파일] 필드를 클릭하고 결과를 포함할 파일을 선택합니다.

  6. 워크시트 필드에서 데이터 워크시트 유형을 선택합니다. 동적으로 표시되는 필드는 워크시트의 데이터 열입니다.

  7. 각 열의 필드를 클릭하고 주문 상태 폴링 속성 목록에서 속성을 선택합니다. 또는 검색 필드를 사용하여 특정 속성을 찾을 수 있습니다.

  8. 각 열 필드에 둘 이상의 속성을 입력할 수 있습니다. 이벤트 열에서 StatusLabel을 선택하고 대시를 삽입한 다음 StatusStartDate를 선택합니다. 즉, 각 주문 상태 업데이트에 대해 상태 레이블 및 상태 시작 날짜가 새 행의 이벤트 열에 기록됩니다.

  9. 새단계를 선택합니다. 참고로 언제든지 마우스를 가리키고 화살표 커넥터를 클릭하여 새 단계를 삽입할 수 있습니다.

  10. 작업 선택 대화 상자에서 TeamWherx 커넥터를 다시 선택한 다음 작업에 대한 클라이언트를 만듭니 다.

대화 상자에 표시되는 각 필드는 Google Sheets 스프레드시트의 열을 나타냅니다. 각 필드를 클릭하여 주문 상태 폴링 속성 목록을 활성화하고 원하는 속성을 선택합니다.

  1. 이 예제에서는 이름 필드에 대한 EmployeeNumber를 선택하여 주문 상태를 업데이트한 직원을 식별합니다.

  2. GroupName을 선택하고 이름 필드에도 삽입합니다.

  3. 저장을 선택합니다.

이제 주문 상태가 업데이트될 때마다 스프레드시트를 직원 번호 및 관련 그룹으로 업데이트하는 프로세스 흐름을 만들었습니다.

## 알려진 문제 및 제한 사항

  • 모든 엔드포인트에 대한 POST(오디오 파일 이진 업로드)는 MP4로만 제한됩니다.

  • 날짜 시간 정보가 필요한 모든 엔드포인트의 날짜는 다음 예제와 같이 RFC3339 지침에 따라 지정해야 합니다. 2021-09-22T02:36:56.52Z. 타임스탬프에서 정확한 초를 지정할 필요는 없습니다. 00은 허용됩니다.

## 일반적인 오류 및 해결

발생할 수 있는 일반적인 오류의 예는 API 개발자 포털에서 응답 코드 및 수정을 찾을 수 있습니다.

앙코르- https://developer.wfmplatform.com/

## FAQ

연결을 만드는 중

커넥터는 다음 인증 유형을 지원합니다.
기본값 연결을 만들기 위한 매개 변수입니다. 모든 지역 공유할 수 없음

기본값

적용 가능: 모든 지역

연결을 만들기 위한 매개 변수입니다.

공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.

이름 유형 Description 필수
API 키 시큐어스트링 (보안 문자열) 이 API의 API 키 진실

제한 한도

Name 호출 갱신 기간
연결당 API 호출 100 60초

동작

CustomListID로 사용자 지정 목록 데이터 가져오기

CustomListID를 사용하여 단일 사용자 지정 목록의 모든 데이터 레코드를 검색합니다.

결과는 열별로 정렬되며 페이징이 지원됩니다.

오류:

404 - 제공된 customListId에 대한 사용자 지정 목록이 없습니다.
CustomListID에서 사용자 지정 목록 필드 목록 가져오기

CustomListID를 사용하여 단일 사용자 지정 목록에 대한 필드 목록을 검색합니다.
GPS 데이터 웹 후크 구독

새 GPS 추적 데이터(GPS 위치) 웹 후크를 추가합니다. 웹 후크를 사용하면 지정된 URL에서 발생하는 GPS 위치를 수신할 수 있습니다.
GPS 데이터 웹 후크 구독 취소

해당 ID로 GPS 데이터 웹 후크 구독을 삭제합니다.
GPS 데이터 피드를 사용하여 웹후크 콜백

이 예제 메서드는 gpsdata/구독에서 고객이 제공한 URL을 사용하여 데이터 피드를 게시하는 데 사용됩니다.
GPS 데이터 항목 가져오기

지정된 날짜 범위에 대한 GPS 데이터 항목을 검색합니다. 연속 토큰과 다음 데이터 부분을 가져오는 링크도 반환합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다.

삭제된 사용자/차량의 위치는 반환되지 않습니다. 그러나 데이터가 요청되었을 때 사용자/차량이 존재하고 나중에 제거된 경우 연속 토큰에서 요청한 사용자/차량의 데이터가 반환됩니다.

결과는 UtcTime 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
ID로 사용자 지정 이벤트 정의 가져오기

ID별로 단일 사용자 지정 이벤트 정의를 검색합니다.
ID로 차량 가져오기

ID로 단일 차량을 검색합니다.
Submit 이벤트

이벤트를 제출합니다.
구독 목록 가져오기

웹 후크 구독 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 SubscriptionId 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
구독 상태를 다시 설정합니다.

구독 상태를 상태 = 1("실행 중")으로 변경합니다.
기존 지오펜스 업데이트

기존 지오펜스를 ID로 업데이트합니다.
부 버전 가져오기

현재 부 버전의 API를 반환합니다.
사용자 가져오기

ID로 사용자를 가져옵니다.
사용자 만들기

새 사용자를 만듭니다.
사용자 목록 가져오기

사용자 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 UserId 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
사용자 비활성화

ID로 기존 사용자를 비활성화합니다.
사용자 업데이트

기존 사용자를 업데이트합니다.
사용자 지정 목록 레코드 만들기 또는 업데이트

사용자 지정 목록 데이터 레코드를 만들거나 업데이트합니다. 고유 열의 값을 생략할 수 있지만 있는 경우 쿼리 매개 변수의 Unique ID 값과 일치해야 합니다.
사용자 지정 목록 레코드 삭제

customListId 및 ID를 사용하여 사용자 지정 목록의 기존 레코드를 삭제합니다.

id - 사용자 지정 목록 레코드의 고유 값입니다.

오류:

404 - customListId 또는 ID를 찾을 수 없습니다.
사용자 지정 목록 정의 가져오기

사용자 지정 목록 정의 목록을 검색합니다. 정의 목록에는 모든 기존 사용자 지정 목록에 대한 CustomListID, 이름 및 버전이 포함됩니다.
사용자 지정 목록에서 단일 레코드 가져오기

CustomListId에서 찾은 단일 사용자 지정 목록 데이터 레코드와 고유한 열 값을 검색합니다.

오류:

404 - 제공된 customListId 및 고유 열 값에 대한 사용자 지정 목록 레코드가 없습니다.
사용자 지정 이벤트 정의 만들기 또는 업데이트

사용자 지정 이벤트 정의를 만들거나 업데이트합니다.
사용자 지정 이벤트 정의 목록 가져오기

사용자 지정 이벤트 정의 목록을 검색합니다.
사용자 지정 이벤트 정의 삭제

사용자 지정 이벤트 정의를 삭제합니다.
사용자 활성화

ID로 기존 사용자를 활성화합니다.
사용자의 일부 업데이트

사용자 속성의 일부를 업데이트합니다.
시간 정리 항목 가져오기

ID로 항목을 검색합니다.
시간 정리 항목 목록 가져오기

날짜 범위에 따라 시간 정리 항목 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 ClockInTime을 기준으로 자동으로 정렬된 다음 TimekeepingStatusId에 따라 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
양식 가져오기

ID로 폼을 검색합니다.
양식 만들기

새 양식을 추가합니다.
양식 목록 가져오기

아래에 표시된 요청 매개 변수에서 필터를 사용하여 양식 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 SubmittedTime 및 내림차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
여행 목록 가져오기

특정 기간 동안의 여정 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 StartUtcTIme 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
이벤트 목록 가져오기

특정 기간 동안의 이벤트 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다.

이벤트 유형별로 필터링하여 특정 이벤트를 가져옵니다. 직원이 차량과 연결된 경우 직원에 대해 차량 이벤트를 반환할 수 있습니다.
이벤트 웹 후크 구독

새 이벤트 웹 후크 구독을 추가합니다. 웹 후크를 사용하면 지정된 URL에서 발생하는 회사 이벤트에 대한 자동 알림을 받을 수 있습니다.
이벤트 웹 후크 구독 목록 가져오기

이벤트 웹 후크 구독 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 SubscriptionId 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
이벤트 웹 후크 구독 상태를 다시 설정합니다.

구독 상태를 상태 = 1("실행 중")으로 변경합니다.
이벤트 웹 후크에서 구독 취소

해당 ID로 이벤트 웹 후크 구독을 삭제합니다.
이벤트 피드를 사용하여 웹 후크 콜백

이 예제 메서드는 이벤트/구독에서 고객이 제공한 URL을 사용하여 이벤트 데이터 피드를 게시하는 데 사용됩니다.
이진 파일 업로드

양식 이미지 및 오디오 파일을 업로드하려면 이 옵션을 사용합니다. 이진 크기는 10MB로 제한됩니다. 지원되는 파일 형식은 JPEG, PNG 및 MP4입니다.
주문 가져오기

ID로 기존 순서를 가져옵니다.
주문 만들기

새 주문을 추가합니다.
주문 목록 가져오기

아래 표시된 요청 매개 변수에서 필터를 사용하여 주문 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 자동으로 Client.Name 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
주문 상태 업데이트

기존 주문 상태를 변경합니다.
주문 업데이트

기존 순서를 업데이트합니다.
지오펜스 가져오기

ID로 지오펜스를 검색합니다.
지오펜스 만들기

새 지오펜스를 만듭니다.
지오펜스 목록 가져오기

지오펜스 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수 및 지오펜스 좌표가 메트릭인지 여부를 지정할 수 있습니다. 결과는 이름 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
지오펜스 삭제

ID로 기존 지오펜스를 삭제합니다.
차량 만들기

차량을 만듭니다.
차량 목록 가져오기

차량 목록을 검색합니다.
차량 부분 업데이트

차량을 ID로 부분 업데이트합니다.
차량 비활성화

ID로 차량을 비활성화합니다.
차량 삭제

ID로 차량을 삭제합니다.
차량 업데이트

ID로 차량을 업데이트합니다.
차량 정품 인증

ID로 차량을 활성화합니다.
첨부 파일 업로드

양식 파일 첨부 파일을 업로드하려면 이 옵션을 사용합니다. 이진 크기는 25MB로 제한됩니다. 단일 파일이 있는 다중 파트/양식 데이터 요청이 필요합니다.
클라이언트 가져오기

ID로 클라이언트 개체를 검색합니다.
클라이언트 만들기

새 클라이언트를 만듭니다.
클라이언트 목록 가져오기

클라이언트 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 이름 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.
클라이언트 삭제

ID로 기존 클라이언트를 삭제합니다.
클라이언트 업데이트

기존 클라이언트를 업데이트합니다.

CustomListID로 사용자 지정 목록 데이터 가져오기

작업 ID:
CustomListController_GetCustomList

CustomListID를 사용하여 단일 사용자 지정 목록의 모든 데이터 레코드를 검색합니다.

결과는 열별로 정렬되며 페이징이 지원됩니다.

오류:

404 - 제공된 customListId에 대한 사용자 지정 목록이 없습니다.

매개 변수

Name 키 필수 형식 Description
customListId
 customListId True integer

사용자 지정 목록 ID입니다.
pageNumber
 pageNumber integer

시작 페이지 번호입니다.
pageSize
 pageSize integer

페이지 크기.

반환

사용자 지정 목록 열 데이터 배열에 대한 컨테이너입니다.

몸
CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

CustomListID에서 사용자 지정 목록 필드 목록 가져오기

작업 ID:
CustomListController_GetById

CustomListID를 사용하여 단일 사용자 지정 목록에 대한 필드 목록을 검색합니다.

매개 변수

Name 키 필수 형식 Description
customListId
 customListId True integer

사용자 지정 목록 ID입니다.

반환

사용자 지정 목록 모델입니다.

몸
CustomerAPI.Models.CustomLists.CustomListApiModel

GPS 데이터 웹 후크 구독

작업 ID:
TrackingController_SubscribeToGpsDataFeed

새 GPS 추적 데이터(GPS 위치) 웹 후크를 추가합니다. 웹 후크를 사용하면 지정된 URL에서 발생하는 GPS 위치를 수신할 수 있습니다.

매개 변수

Name 키 필수 형식 Description
웹 주소
 Url string

WebHookSubscriptionParamsApiModel의 주소를 포함하는 URL입니다.
SecurityToken
 SecurityToken string

이 WebHookSubscriptionParamsApiModel과 연결된 보안 토큰입니다.

반환

몸
CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

GPS 데이터 웹 후크 구독 취소

작업 ID:
TrackingController_RemoveGpsDataFeedSubscription

해당 ID로 GPS 데이터 웹 후크 구독을 삭제합니다.

매개 변수

Name 키 필수 형식 Description
subscriptionId
 subscriptionId True string

삭제할 구독 ID입니다.

GPS 데이터 피드를 사용하여 웹후크 콜백

작업 ID:
TrackingController_subscribe_callback

이 예제 메서드는 gpsdata/구독에서 고객이 제공한 URL을 사용하여 데이터 피드를 게시하는 데 사용됩니다.

매개 변수

Name 키 필수 형식 Description
아이디
 Id string

WebHookSubscriptionParamsApiModel의 주소를 포함하는 URL입니다.
DeviceId
 DeviceId string

구독과 연결된 GpsDeviceDto ID입니다.
디바이스 유형
 DeviceType integer

GpsDeviceDto 유형: 핸드셋(0), CalAmp(1), Geotab (2), Xirgo (3).
시간표시
 Timestamp date-time

로컬 및 오프셋이 있는 ISO 형식입니다.
CompanyId
 CompanyId integer

회사 ID입니다.
UserId
 UserId integer

사용자 ID입니다.
VehicleId
 VehicleId integer

차량 ID입니다.
UserLinkedToVehicle
 UserLinkedToVehicle boolean

사용자가 차량에 연결되었는지 여부입니다.
LocationProvider
 LocationProvider string

위치 공급자 이름입니다.
Lat
 Lat double

위도.
론
 Lon double

경도.
AccuracyFt
 AccuracyFt double

위치 정확도(피트).
AltitudeFt
 AltitudeFt double

고도(피트).
Heading
 Heading integer

나침반 방향(도)입니다.
SpeedMph
 SpeedMph double

이동 속도(Mph).
BatteryStatus
 BatteryStatus integer

배터리 상태: 충전 안 됨(0), 충전(1).
BatteryLevel
 BatteryLevel integer

배터리 잔량(백분율)입니다.
ActivityState
 ActivityState integer

활동 상태: Staying(1), Modving(2).
IsNetworkConnected
 IsNetworkConnected boolean

현재 네트워크에 연결된 디바이스입니다.
Rssi
 Rssi integer

신호 강도 표시기를 받았습니다.
DOdoMl
 DOdoMl double

GpsDeviceDto 주행 거리계 (마일).
VOdoMl
 VOdoMl double

차량 주행 거리계(마일).

반환

response
object

GPS 데이터 항목 가져오기

작업 ID:
TrackingController_GetGpsData

지정된 날짜 범위에 대한 GPS 데이터 항목을 검색합니다. 연속 토큰과 다음 데이터 부분을 가져오는 링크도 반환합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다.

삭제된 사용자/차량의 위치는 반환되지 않습니다. 그러나 데이터가 요청되었을 때 사용자/차량이 존재하고 나중에 제거된 경우 연속 토큰에서 요청한 사용자/차량의 데이터가 반환됩니다.

결과는 UtcTime 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
fromDate
 fromDate date-time

날짜 범위 시작 권장 사항: 작은 날짜 범위 대신 큰 날짜 범위(>=4시간)를 사용하세요.
toDate
 toDate date-time

날짜 범위 끝입니다. 권장 사항: 작은 날짜 범위 대신 큰 날짜 범위(>=4시간)를 사용하세요.
** 직원 번호
 employeeNumber string

직원 번호입니다.
빈 (vin)
 vin string

차량의 VIN 번호입니다.
useMetric
 useMetric boolean

메트릭 시스템 사용 여부
token
 token string

초기 호출에서 반환되고 연속 호출에 사용되는 연속 토큰입니다.

반환

몸
CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

ID로 사용자 지정 이벤트 정의 가져오기

작업 ID:
EventController_Get

ID별로 단일 사용자 지정 이벤트 정의를 검색합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

이벤트 정의 ID입니다.

반환

사용자 지정 이벤트 정의 모델입니다.

몸
CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

ID로 차량 가져오기

작업 ID:
VehicleController_GetVehicle

ID로 단일 차량을 검색합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

차량 데이터 모델.

몸
CustomerAPI.Models.Vehicles.VehicleReadApi

Submit 이벤트

작업 ID:
EventController_Post

이벤트를 제출합니다.

매개 변수

Name 키 필수 형식 Description
EventDefinitionId
 EventDefinitionId string

이벤트 정의 ID입니다.
직원번호
 EmployeeNumber string

직원 번호입니다.
VehicleNumber
 VehicleNumber string

차량 번호입니다.
DeviceSerialNumber
 DeviceSerialNumber string

GpsDeviceDto 일련 번호입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
시간
 Time date-time
매개 변수
 Parameters object

이벤트 매개 변수입니다.

구독 목록 가져오기

작업 ID:
TrackingController_GetSubscriptions

웹 후크 구독 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 SubscriptionId 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

반환

response
array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

구독 상태를 다시 설정합니다.

작업 ID:
TrackingController_ResetSubscriptionHealthStatus

구독 상태를 상태 = 1("실행 중")으로 변경합니다.

매개 변수

Name 키 필수 형식 Description
subscriptionId
 subscriptionId True integer

구독 ID입니다.

기존 지오펜스 업데이트

작업 ID:
GeofenceController_UpdateGeofence

기존 지오펜스를 ID로 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True integer

지오펜스 ID입니다.
GroupNames
 GroupNames array of string

GeofenceUpdateApiModel의 GroupPaths입니다.
위도
 Latitude double
경도
 Longitude double
이름
 Name string

GeofenceApiModelBase의 이름입니다.
유형
 Type string

GeofenceApiModel의 형식입니다.
Shape
 Shape integer

도형: 원의 경우 0, 다각형의 경우 1입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
Radius
 Radius double

GeofenceApiModel의 반지름입니다.
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel의 UseGeofenceAddress입니다.
useMetric
 useMetric boolean

메트릭 시스템 사용 여부
geocode
 geocode boolean

주소는 지오코딩되어야 합니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

부 버전 가져오기

작업 ID:
VersionController_Get

현재 부 버전의 API를 반환합니다.

사용자 가져오기

작업 ID:
UserController_Get

ID로 사용자를 가져옵니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.User.ReadUserApiModel

사용자 만들기

작업 ID:
UserController_Create

새 사용자를 만듭니다.

매개 변수

Name 키 필수 형식 Description
사용자 이름
 UserName string

사용자의 UserName입니다.
암호
 Password password

사용자의 암호입니다.
GroupName
 GroupName string

사용자 그룹의 이름입니다.
이름 (FirstName)
 FirstName string

사용자의 이름입니다.
성씨
 LastName string

사용자의 성입니다.
직원번호
 EmployeeNumber string

사용자의 직원 번호입니다.
전자 메일
 Email string

사용자의 전자 메일 주소입니다.
Phone
 Phone string

사용자의 전화 번호입니다.
RoleId
 RoleId integer

사용자의 RoleId - (Admin: 1, User: 3, Power User: 5).
IsActive
 IsActive boolean

사용자의 활성 상태입니다.
EPTTEnabled
 EPTTEnabled boolean

사용자에 대한 향상된 푸시 투 토크 기능의 상태: 부울.
EPTTNumber
 EPTTNumber string

사용자용 향상된 통화 푸시-투-토크 기능의 전화 번호: 문자열입니다.
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 전화 번호 - Kodiak에서 제공합니다.
EPTTToken
 EPTTToken string

Kodiak에서 제공하는 Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 API 토큰입니다.
GPSEnabled
 GPSEnabled boolean

사용자의 GPS 기능 상태입니다.
MobileOnly
 MobileOnly boolean

CAB에 대한 데스크톱 웹 애플리케이션 액세스 상태 - (WebApp Access 없음: True, 전체 앱 액세스: False).
LicenseType
 LicenseType integer

사용자에게 할당된 라이선스 유형: - 정의되지 않은 경우 0, 정규용 1개, WebOnly의 경우 2, 직원의 경우 3입니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

사용자 목록 가져오기

작업 ID:
UserController_GetUsers

사용자 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 UserId 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
pageNumber
 pageNumber integer

시작 페이지 번호입니다. 기본값은 1입니다.
pageSize
 pageSize integer

페이지 크기. 기본값은 500입니다.

반환

response
array of CustomerAPI.Models.User.ReadUserListItemApiModel

사용자 비활성화

작업 ID:
UserController_Deactivate

ID로 기존 사용자를 비활성화합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

사용자 업데이트

작업 ID:
UserController_Update

기존 사용자를 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
사용자 이름
 UserName string

사용자의 UserName입니다.
암호
 Password password

사용자의 암호입니다.
GroupName
 GroupName string

사용자 그룹의 이름입니다.
이름 (FirstName)
 FirstName string

사용자의 이름입니다.
성씨
 LastName string

사용자의 성입니다.
직원번호
 EmployeeNumber string

사용자의 직원 번호입니다.
전자 메일
 Email string

사용자의 전자 메일 주소입니다.
Phone
 Phone string

사용자의 전화 번호입니다.
RoleId
 RoleId integer

사용자의 RoleId - (Admin: 1, User: 3, Power User: 5).
IsActive
 IsActive boolean

사용자의 활성 상태입니다.
EPTTEnabled
 EPTTEnabled boolean

사용자에 대한 향상된 푸시 투 토크 기능의 상태: 부울.
EPTTNumber
 EPTTNumber string

사용자용 향상된 통화 푸시-투-토크 기능의 전화 번호: 문자열입니다.
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 전화 번호 - Kodiak에서 제공합니다.
EPTTToken
 EPTTToken string

Kodiak에서 제공하는 Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 API 토큰입니다.
GPSEnabled
 GPSEnabled boolean

사용자의 GPS 기능 상태입니다.
MobileOnly
 MobileOnly boolean

CAB에 대한 데스크톱 웹 애플리케이션 액세스 상태 - (WebApp Access 없음: True, 전체 앱 액세스: False).
LicenseType
 LicenseType integer

사용자에게 할당된 라이선스 유형: - 정의되지 않은 경우 0, 정규용 1개, WebOnly의 경우 2, 직원의 경우 3입니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

사용자 지정 목록 레코드 만들기 또는 업데이트

작업 ID:
CustomListController_PutRecord

사용자 지정 목록 데이터 레코드를 만들거나 업데이트합니다. 고유 열의 값을 생략할 수 있지만 있는 경우 쿼리 매개 변수의 Unique ID 값과 일치해야 합니다.

매개 변수

Name 키 필수 형식 Description
customListId
 customListId True integer

사용자 지정 목록 ID입니다.
아이디
 id True string

고유 값입니다.
ColumnIndex
 ColumnIndex integer

사용자 지정 목록 열 인덱스입니다.
캡션
 Caption string

사용자 지정 목록 열 캡션입니다.
가치
 Value

사용자 지정 목록 열 값입니다.

사용자 지정 목록 레코드 삭제

작업 ID:
CustomListController_DeleteRecord

customListId 및 ID를 사용하여 사용자 지정 목록의 기존 레코드를 삭제합니다.

id - 사용자 지정 목록 레코드의 고유 값입니다.

오류:

404 - customListId 또는 ID를 찾을 수 없습니다.

매개 변수

Name 키 필수 형식 Description
customListId
 customListId True integer

사용자 지정 목록 ID입니다.
아이디
 id True string

고유 값입니다.

사용자 지정 목록 정의 가져오기

작업 ID:
CustomListController_Get

사용자 지정 목록 정의 목록을 검색합니다. 정의 목록에는 모든 기존 사용자 지정 목록에 대한 CustomListID, 이름 및 버전이 포함됩니다.

반환

response
array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

사용자 지정 목록에서 단일 레코드 가져오기

작업 ID:
CustomListController_GetSingleRecord

CustomListId에서 찾은 단일 사용자 지정 목록 데이터 레코드와 고유한 열 값을 검색합니다.

오류:

404 - 제공된 customListId 및 고유 열 값에 대한 사용자 지정 목록 레코드가 없습니다.

매개 변수

Name 키 필수 형식 Description
customListId
 customListId True integer

사용자 지정 목록 ID입니다.
아이디
 id True string

고유 값입니다.

반환

사용자 지정 목록 열 데이터 배열에 대한 컨테이너입니다.

몸
CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

사용자 지정 이벤트 정의 만들기 또는 업데이트

작업 ID:
EventController_Put

사용자 지정 이벤트 정의를 만들거나 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

이벤트 정의 ID입니다.
이름
 Name string
ReverseGeocode
 ReverseGeocode boolean
이름
 Name string
유형
 Type integer
캡션
 Caption string
필수
 Required boolean

사용자 지정 이벤트 정의 목록 가져오기

작업 ID:
EventController_GetList

사용자 지정 이벤트 정의 목록을 검색합니다.

반환

response
array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

사용자 지정 이벤트 정의 삭제

작업 ID:
EventController_Delete

사용자 지정 이벤트 정의를 삭제합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

이벤트 정의 ID입니다.

사용자 활성화

작업 ID:
UserController_Activate

ID로 기존 사용자를 활성화합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

사용자의 일부 업데이트

작업 ID:
UserController_PartialUpdate

사용자 속성의 일부를 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
object
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

시간 정리 항목 가져오기

작업 ID:
TimekeepingController_GetTimekeepingEntryAsync

ID로 항목을 검색합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

레코드의 ID입니다.

반환

몸
CustomerAPI.Models.Timekeeping.TimekeepingApiModel

시간 정리 항목 목록 가져오기

작업 ID:
TimekeepingController_GetTimekeepingDataList

날짜 범위에 따라 시간 정리 항목 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 ClockInTime을 기준으로 자동으로 정렬된 다음 TimekeepingStatusId에 따라 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
fromDate
 fromDate True date-time

시작 날짜입니다.
toDate
 toDate True date-time

종료 날짜입니다.
** 직원 번호
 employeeNumber string

직원 번호입니다.
승인
 approved boolean

승인된 항목에 대해서만 필터링합니다.
closedOnly
 closedOnly boolean

닫힌 항목에 대해서만 필터링합니다.
excludeFormData
 excludeFormData boolean

양식 데이터를 제외하기 위한 필터입니다.
pageNumber
 pageNumber integer

시작 페이지 번호(기본값 1).
pageSize
 pageSize integer

페이지 크기(기본값 1000).

반환

response
array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

양식 가져오기

작업 ID:
FormController_GetFormAsync

ID로 폼을 검색합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True integer

양식 ID입니다.

반환

몸
CustomerAPI.Models.Forms.StandaloneFormApiModel

양식 만들기

작업 ID:
FormController_PostFormAsync

새 양식을 추가합니다.

매개 변수

Name 키 필수 형식 Description
ApiModuleId
 ApiModuleId string

이 CreateStandaloneFormApiModel과 연결된 ApiModule의 ID입니다.
검토
 Reviewed boolean

이 CreateStandaloneFormApiModel 검토의 상태입니다.
UserId
 UserId integer

사용자의 UserId입니다.
직원번호
 EmployeeNumber string

사용자의 직원 번호입니다.
SubmittedTime
 SubmittedTime True date-time

CreateStandaloneFormApiModel이 제출된 시점입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
ApiFieldId
 ApiFieldId True string

API 필드 ID입니다.
가치
 Value True

FormFieldDataApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"Sign" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

이진 데이터가 캡처된 시간입니다. 형식 - 오프셋을 포함한 날짜-시간(RFC3339 날짜-시간으로)
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
ApiFieldId
 ApiFieldId True string

API 필드 ID입니다.
가치
 Value True

FormFieldDataApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"Sign" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

이진 데이터가 캡처된 시간입니다. 형식 - 오프셋을 포함한 날짜-시간(RFC3339 날짜-시간으로)

반환

몸
CustomerAPI.Models.ReturnIdApiModel

양식 목록 가져오기

작업 ID:
FormController_GetFormsAsync

아래에 표시된 요청 매개 변수에서 필터를 사용하여 양식 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 SubmittedTime 및 내림차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
submittedStartDate
 submittedStartDate True date-time

제출된 양식의 시작 날짜입니다.
submittedEndDate
 submittedEndDate True date-time

제출된 양식의 종료 날짜입니다.
apiModuleId
 apiModuleId string

양식 모듈 ID입니다.
** 직원 번호
 employeeNumber string

직원 번호입니다.
검토됨
 reviewed boolean

검토된 양식만 검색하거나 검색하지 않습니다. 기본값은 모두 null입니다.
pageNumber
 pageNumber integer

시작 페이지 번호입니다. 기본값은 1입니다.
pageSize
 pageSize integer

페이지 크기. 기본값은 1000입니다.

반환

response
array of CustomerAPI.Models.Forms.StandaloneFormApiModel

여행 목록 가져오기

작업 ID:
TrackingController_GetTrips

특정 기간 동안의 여정 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 StartUtcTIme 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
fromDate
 fromDate True date-time

날짜 범위 시작 권장 사항: 작은 날짜 범위 대신 큰 날짜 범위(>=4시간)를 사용하세요.
toDate
 toDate True date-time

날짜 범위 끝입니다. 권장 사항: 작은 날짜 범위 대신 큰 날짜 범위(>=4시간)를 사용하세요.
** 직원 번호
 employeeNumber string

직원 번호입니다.
빈 (vin)
 vin string

차량의 VIN 번호입니다.
pageNumber
 pageNumber integer

시작 페이지 번호입니다. 기본값은 1입니다.
pageSize
 pageSize integer

페이지 크기. 기본값은 1000입니다.
useMetric
 useMetric boolean

메트릭 시스템 사용 여부

반환

response
array of CustomerAPI.Models.Tracking.TripApiModel

이벤트 목록 가져오기

작업 ID:
EventController_GetEvents

특정 기간 동안의 이벤트 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다.

이벤트 유형별로 필터링하여 특정 이벤트를 가져옵니다. 직원이 차량과 연결된 경우 직원에 대해 차량 이벤트를 반환할 수 있습니다.

매개 변수

Name 키 필수 형식 Description
fromDate
 fromDate True date-time

날짜 범위 시작
toDate
 toDate True date-time

날짜 범위 끝입니다.
** 직원 번호
 employeeNumber string

직원 번호입니다.
vehicleNumber
 vehicleNumber string

차량 번호입니다.
pageNumber
 pageNumber integer

시작 페이지 번호입니다.
pageSize
 pageSize integer

페이지 크기.
eventType
 eventType integer

이벤트 유형별로 필터링합니다.

직원 번호가 지정됩니다.

  • UserEvents(0) - 사용자 이벤트만.
  • VehicleEvents(1) - 센서 이벤트를 포함한 차량 이벤트만.
  • ExternalEvents(2) - 외부 이벤트만.

차량 번호가 지정됩니다.

  • UserEvents(0) - N/A.
  • VehicleEvents(1) - 센서 이벤트를 포함한 차량 이벤트만.
  • ExternalEvents(2) - 외부 이벤트만.

직원 번호나 차량 번호는 지정되지 않습니다.

  • UserEvents(0) - 사용자 이벤트만.
  • VehicleEvents(1) - 센서 이벤트를 포함한 차량 이벤트만.
  • ExternalEvents(2) - 외부 이벤트만.

반환

response
array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

이벤트 웹 후크 구독

작업 ID:
EventController_SubscribeToEventDataFeed

새 이벤트 웹 후크 구독을 추가합니다. 웹 후크를 사용하면 지정된 URL에서 발생하는 회사 이벤트에 대한 자동 알림을 받을 수 있습니다.

매개 변수

Name 키 필수 형식 Description
웹 주소
 Url string

WebHookSubscriptionParamsApiModel의 주소를 포함하는 URL입니다.
SecurityToken
 SecurityToken string

이 WebHookSubscriptionParamsApiModel과 연결된 보안 토큰입니다.

반환

몸
CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

이벤트 웹 후크 구독 목록 가져오기

작업 ID:
EventController_GetSubscriptions

이벤트 웹 후크 구독 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 SubscriptionId 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

반환

response
array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

이벤트 웹 후크 구독 상태를 다시 설정합니다.

작업 ID:
EventController_ResetSubscriptionHealthStatus

구독 상태를 상태 = 1("실행 중")으로 변경합니다.

매개 변수

Name 키 필수 형식 Description
subscriptionId
 subscriptionId True integer

구독 ID입니다.

이벤트 웹 후크에서 구독 취소

작업 ID:
EventController_RemoveEventDataFeedSubscription

해당 ID로 이벤트 웹 후크 구독을 삭제합니다.

매개 변수

Name 키 필수 형식 Description
subscriptionId
 subscriptionId True string

삭제할 구독 ID입니다.

이벤트 피드를 사용하여 웹 후크 콜백

작업 ID:
EventController_subscribe_callback

이 예제 메서드는 이벤트/구독에서 고객이 제공한 URL을 사용하여 이벤트 데이터 피드를 게시하는 데 사용됩니다.

매개 변수

Name 키 필수 형식 Description
아이디
 Id string

WebHookSubscriptionParamsApiModel의 주소를 포함하는 URL입니다.
이벤트 유형
 EventType integer
EventCode
 EventCode string
EventTime
 EventTime date-time

로컬 및 오프셋이 있는 ISO 형식입니다.
DeviceId
 DeviceId string

구독과 연결된 GpsDeviceDto ID입니다.
디바이스 유형
 DeviceType integer

GpsDeviceDto 유형: 핸드셋 (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId
 UserId integer

사용자 ID입니다.
VehicleId
 VehicleId integer

차량 ID입니다.
UserLinkedToVehicle
 UserLinkedToVehicle boolean

사용자가 차량에 연결되었는지 여부입니다.
Lat
 Lat double

위도.
론
 Lon double

경도.
CustomEventDefinitionId
 CustomEventDefinitionId string
EventParams
 EventParams object

이벤트 매개 변수입니다.

반환

response
object

이진 파일 업로드

작업 ID:
BinaryController_UploadBinary

양식 이미지 및 오디오 파일을 업로드하려면 이 옵션을 사용합니다. 이진 크기는 10MB로 제한됩니다. 지원되는 파일 형식은 JPEG, PNG 및 MP4입니다.

반환

몸
CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

주문 가져오기

작업 ID:
OrderController_GetOrder

ID로 기존 순서를 가져옵니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
include-status-history
 include-status-history string

true이면 응답에 이 주문에 대한 모든 상태 기록 및 양식 데이터가 포함됩니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.Order.OrderApiModel

주문 만들기

작업 ID:
OrderController_Create

새 주문을 추가합니다.

매개 변수

Name 키 필수 형식 Description
생성일시
 CreatedDateTime date-time

이 CreateUpdateOrderApiModel이 만들어진 시점입니다.
ExternalClientId
 ExternalClientId True string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
ServiceType
 ServiceType True string

이 CreateUpdateOrderApiModel과 연결된 서비스 유형입니다.
ExternalOrderId
 ExternalOrderId string

클라이언트 - API 확장 속성에 대한 외부 사용 OrderId입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
이름
 Name string

ContactApiModel의 이름입니다.
전화번호
 PhoneNumber string

ContactApiModel의 PhoneNumber입니다.
전자 메일
 Email string

ContactApiModel의 전자 메일입니다.
마감일
 DueDate date-time

이 BaseUpdateOrderApiModel이 완료될 예정입니다(v1.3에서는 사용되지 않음).
StartTime
 StartTime date-time

이 BaseUpdateOrderApiModel이 시작되어야 하는 시점(v1.3에 도입됨).
EndTime
 EndTime date-time

이 BaseUpdateOrderApiModel이 종료되어야 하는 시점(v1.3에 도입됨).
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
직원번호
 EmployeeNumber True string

이 NewOrderStatusApiModel을 만든 사용자의 EmployeeNumber입니다.
StatusLabel
 StatusLabel True string

이 NewOrderStatusApiModel과 연결된 StatusLabel의 콘텐츠에 레이블을 지정합니다.
StatusStartDateTime
 StatusStartDateTime True date-time

이 NewOrderStatusApiModel 상태가 시작된 시점입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
FieldIndex
 FieldIndex integer

필드 인덱스입니다.
가치
 Value

필드 값입니다.
geocode
 geocode boolean

주소는 지오코딩되어야 합니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

주문 목록 가져오기

작업 ID:
OrderController_GetOrders

아래 표시된 요청 매개 변수에서 필터를 사용하여 주문 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 자동으로 Client.Name 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
dueDateFrom
 dueDateFrom True date-time

기한 시작 날짜를 기준으로 필터링합니다.
dueDateTo
 dueDateTo True date-time

기한 종료 날짜를 기준으로 필터링합니다.
** 직원 번호
 employeeNumber string

직원 번호를 기준으로 필터링합니다.
pageNumber
 pageNumber integer

시작 페이지 번호(기본값 1).
pageSize
 pageSize integer

페이지 크기(기본값 500).

반환

response
array of CustomerAPI.Models.Order.OrderListItemApiModel

주문 상태 업데이트

작업 ID:
OrderController_ChangeStatus

기존 주문 상태를 변경합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
직원번호
 EmployeeNumber True string

이 NewOrderStatusApiModel을 만든 사용자의 EmployeeNumber입니다.
StatusLabel
 StatusLabel True string

이 NewOrderStatusApiModel과 연결된 StatusLabel의 콘텐츠에 레이블을 지정합니다.
StatusStartDateTime
 StatusStartDateTime True date-time

이 NewOrderStatusApiModel 상태가 시작된 시점입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

주문 업데이트

작업 ID:
OrderController_Update

기존 순서를 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
ExternalOrderId
 ExternalOrderId string

클라이언트 - API 확장 속성에 대한 외부 사용 OrderId입니다.
IsClosed
 IsClosed boolean

UpdateOrderApiModel이 닫혔는지를 보여 주는 상태입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
이름
 Name string

ContactApiModel의 이름입니다.
전화번호
 PhoneNumber string

ContactApiModel의 PhoneNumber입니다.
전자 메일
 Email string

ContactApiModel의 전자 메일입니다.
마감일
 DueDate date-time

이 BaseUpdateOrderApiModel이 완료될 예정입니다(v1.3에서는 사용되지 않음).
StartTime
 StartTime date-time

이 BaseUpdateOrderApiModel이 시작되어야 하는 시점(v1.3에 도입됨).
EndTime
 EndTime date-time

이 BaseUpdateOrderApiModel이 종료되어야 하는 시점(v1.3에 도입됨).
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
직원번호
 EmployeeNumber True string

이 NewOrderStatusApiModel을 만든 사용자의 EmployeeNumber입니다.
StatusLabel
 StatusLabel True string

이 NewOrderStatusApiModel과 연결된 StatusLabel의 콘텐츠에 레이블을 지정합니다.
StatusStartDateTime
 StatusStartDateTime True date-time

이 NewOrderStatusApiModel 상태가 시작된 시점입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
캡션
 Caption True string
가치
 Value

UpdateFormFieldApiModel의 값입니다.

"NFC" 필드 값 형식: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열, // 이진 ID(업로드 이진 API 참조) "참고": 문자열 // 참조된 이미지에 대한 참고 }

"서명" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 이미지의 문자열 // 이진 ID(이진 API 업로드 참조) }

"Audio" 필드 값 형식(이진 참조): { "BinaryId": 업로드된 오디오의 문자열, // 이진 ID(업로드 이진 API 참조) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

지정 시간 값이 캡처되었습니다.
FieldIndex
 FieldIndex integer

필드 인덱스입니다.
가치
 Value

필드 값입니다.
geocode
 geocode boolean

주소는 지오코딩되어야 합니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

지오펜스 가져오기

작업 ID:
GeofenceController_GetGeofence

ID로 지오펜스를 검색합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True integer

지오펜스 ID입니다.
useMetric
 useMetric boolean

메트릭 시스템 사용 여부

반환

몸
CustomerAPI.Models.Geofence.GeofenceApiModel

지오펜스 만들기

작업 ID:
GeofenceController_CreateGeofence

새 지오펜스를 만듭니다.

매개 변수

Name 키 필수 형식 Description
GroupNames
 GroupNames array of string

GeofenceCreateApiModel의 GroupPaths입니다.
위도
 Latitude double
경도
 Longitude double
이름
 Name string

GeofenceApiModelBase의 이름입니다.
유형
 Type string

GeofenceApiModel의 형식입니다.
Shape
 Shape integer

도형: 원의 경우 0, 다각형의 경우 1입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
Radius
 Radius double

GeofenceApiModel의 반지름입니다.
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel의 UseGeofenceAddress입니다.
useMetric
 useMetric boolean

메트릭 시스템 사용 여부
geocode
 geocode boolean

주소는 지오코딩되어야 합니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

지오펜스 목록 가져오기

작업 ID:
GeofenceController_GetGeofences

지오펜스 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수 및 지오펜스 좌표가 메트릭인지 여부를 지정할 수 있습니다. 결과는 이름 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
pageNumber
 pageNumber integer

시작 페이지 번호입니다. 기본값은 1입니다.
pageSize
 pageSize integer

페이지 크기. 기본값은 500입니다.
useMetric
 useMetric boolean

메트릭 시스템 사용 여부

반환

response
array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

지오펜스 삭제

작업 ID:
GeofenceController_DeleteGeofence

ID로 기존 지오펜스를 삭제합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True integer

지오펜스 ID입니다.

차량 만들기

작업 ID:
VehicleController_CreateVehicle

차량을 만듭니다.

매개 변수

Name 키 필수 형식 Description
Number
 Number string
이름
 Name string
유형
 Type string
Tag
 Tag string
UserEmployeeNumber
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
만들다
 Make string
연도
 Year integer
Model
 Model string
색깔
 Color string
VIN(VIN)
 VIN string
IsActive
 IsActive boolean
디바이스 유형
 DeviceType integer
DeviceSerialNumber
 DeviceSerialNumber string

반환

몸
CustomerAPI.Models.ReturnIdApiModel

차량 목록 가져오기

작업 ID:
VehicleController_GetVehicles

차량 목록을 검색합니다.

매개 변수

Name 키 필수 형식 Description
pageNumber
 pageNumber integer

페이지 번호입니다.
pageSize
 pageSize integer

페이지의 최대 항목 수입니다. 기본값 = 1000 최대값 = 2000
activeOnly
 activeOnly boolean

true이면 활성 차량만 반환합니다. 기본값 = false입니다.

반환

response
array of CustomerAPI.Models.Vehicles.VehicleReadApi

차량 부분 업데이트

작업 ID:
VehicleController_PartialUpdateVehicle

차량을 ID로 부분 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
object
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

차량 비활성화

작업 ID:
VehicleController_Deactivate

ID로 차량을 비활성화합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

response
integer

차량 삭제

작업 ID:
VehicleController_Delete

ID로 차량을 삭제합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

차량 업데이트

작업 ID:
VehicleController_UpdateVehicle

ID로 차량을 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
Number
 Number string
이름
 Name string
유형
 Type string
Tag
 Tag string
UserEmployeeNumber
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
만들다
 Make string
연도
 Year integer
Model
 Model string
색깔
 Color string
VIN(VIN)
 VIN string
IsActive
 IsActive boolean
디바이스 유형
 DeviceType integer
DeviceSerialNumber
 DeviceSerialNumber string
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

response
integer

차량 정품 인증

작업 ID:
VehicleController_Activate

ID로 차량을 활성화합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

response
integer

첨부 파일 업로드

작업 ID:
BinaryController_UploadAttachment

양식 파일 첨부 파일을 업로드하려면 이 옵션을 사용합니다. 이진 크기는 25MB로 제한됩니다. 단일 파일이 있는 다중 파트/양식 데이터 요청이 필요합니다.

반환

몸
CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

클라이언트 가져오기

작업 ID:
ClientController_Get

ID로 클라이언트 개체를 검색합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

클라이언트 ID입니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.Client.ReadClientApiModel

클라이언트 만들기

작업 ID:
ClientController_Create

새 클라이언트를 만듭니다.

매개 변수

Name 키 필수 형식 Description
ExternalId
 ExternalId string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
FieldIndex
 FieldIndex integer

필드 인덱스입니다.
가치
 Value

필드 값입니다.
이름
 Name string

클라이언트의 이름입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
이름
 Name string

ContactApiModel의 이름입니다.
전화번호
 PhoneNumber string

ContactApiModel의 PhoneNumber입니다.
전자 메일
 Email string

ContactApiModel의 전자 메일입니다.
geocode
 geocode boolean

주소는 지오코딩되어야 합니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

클라이언트 목록 가져오기

작업 ID:
ClientController_GetClients

클라이언트 목록을 검색합니다. 반환되는 페이지 수와 페이지당 요소 수를 지정할 수 있습니다. 결과는 이름 및 오름차순으로 자동으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

매개 변수

Name 키 필수 형식 Description
pageNumber
 pageNumber integer

시작 페이지 번호입니다.
pageSize
 pageSize integer

페이지 크기.

반환

response
array of CustomerAPI.Models.Client.ReadClientApiModel

클라이언트 삭제

작업 ID:
ClientController_Delete

ID로 기존 클라이언트를 삭제합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

클라이언트 ID입니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

클라이언트 업데이트

작업 ID:
ClientController_Update

기존 클라이언트를 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
아이디
 id True string

외부 또는 내부 ID는 use-external-id 매개 변수의 값에 따라 달라집니다.
ExternalId
 ExternalId string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
FieldIndex
 FieldIndex integer

필드 인덱스입니다.
가치
 Value

필드 값입니다.
이름
 Name string

클라이언트의 이름입니다.
위도
 Latitude double
경도
 Longitude double
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.
이름
 Name string

ContactApiModel의 이름입니다.
전화번호
 PhoneNumber string

ContactApiModel의 PhoneNumber입니다.
전자 메일
 Email string

ContactApiModel의 전자 메일입니다.
geocode
 geocode boolean

주소는 지오코딩되어야 합니다.
use-external-id
 use-external-id boolean

외부 ID를 사용하거나 사용하지 않습니다.

반환

몸
CustomerAPI.Models.ReturnIdApiModel

트리거

시간 보관 설문 조사

Timekeeping API 폴링 엔드포인트를 사용하면 애플리케이션이 최근에 제출한 시간 보관 항목을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 제출된 시간 보관 레코드가 있습니다. 응답 본문에 시간 보관 항목 데이터가 표시됩니다.
  • HTTP 응답 코드 202 - 최근에 제출된 레코드가 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 시간 유지 항목이 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc 및 TimekeepingStatusId에 따라 자동으로 정렬된 다음 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 시간 유지 상태 변경 시간입니다.
양식 데이터 폴링

Forms API 폴링 엔드포인트를 사용하면 애플리케이션이 최근에 제출한 독립 실행형 양식을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 제출된 양식 레코드가 있습니다. 응답 본문에 양식 데이터가 표시됩니다.
  • HTTP 응답 코드 202 - 최근에 제출된 레코드가 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 양식이 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc 및 FormHeaderId 순으로 자동으로 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 양식 데이터 변경 시간입니다.
주문 상태 폴링

주문 상태 API 폴링 엔드포인트를 사용하면 애플리케이션이 최근 주문 변경 내용을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 변경된 주문 상태 레코드가 있습니다. 응답 본문에 주문 상태 데이터가 표시됩니다.
  • HTTP 응답 코드 202 - 최근에 제출된 레코드가 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 주문 상태가 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc를 기준으로 정렬된 다음 StatusId를 기준으로 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 주문 상태 데이터 변경 시간입니다.
주문 설문 조사

Orders API 폴링 엔드포인트를 사용하면 애플리케이션이 최근 주문 변경 내용을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 변경된 주문이 있습니다. 응답 본문은 주문 데이터를 표시합니다.
  • HTTP 응답 코드 202 - 최근에 변경된 주문이 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 순서 변경 내용이 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc 및 OrderId에 따라 자동으로 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 주문 데이터 변경 시간입니다.

시간 보관 설문 조사

작업 ID:
TimekeepingController_Poll

Timekeeping API 폴링 엔드포인트를 사용하면 애플리케이션이 최근에 제출한 시간 보관 항목을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 제출된 시간 보관 레코드가 있습니다. 응답 본문에 시간 보관 항목 데이터가 표시됩니다.
  • HTTP 응답 코드 202 - 최근에 제출된 레코드가 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 시간 유지 항목이 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc 및 TimekeepingStatusId에 따라 자동으로 정렬된 다음 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 시간 유지 상태 변경 시간입니다.

매개 변수

Name 키 필수 형식 Description
excludeFormData
 excludeFormData boolean

true이면 ClockInFormData 및 ClockOutFormData는 항상 null이 됩니다.

반환

몸
CustomerAPI.Models.Timekeeping.TimekeepingApiModel

양식 데이터 폴링

작업 ID:
FormController_Poll

Forms API 폴링 엔드포인트를 사용하면 애플리케이션이 최근에 제출한 독립 실행형 양식을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 제출된 양식 레코드가 있습니다. 응답 본문에 양식 데이터가 표시됩니다.
  • HTTP 응답 코드 202 - 최근에 제출된 레코드가 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 양식이 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc 및 FormHeaderId 순으로 자동으로 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 양식 데이터 변경 시간입니다.

반환

몸
CustomerAPI.Models.Forms.StandaloneFormApiModel

주문 상태 폴링

작업 ID:
OrderController_StatusPoll

주문 상태 API 폴링 엔드포인트를 사용하면 애플리케이션이 최근 주문 변경 내용을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 변경된 주문 상태 레코드가 있습니다. 응답 본문에 주문 상태 데이터가 표시됩니다.
  • HTTP 응답 코드 202 - 최근에 제출된 레코드가 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 주문 상태가 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc를 기준으로 정렬된 다음 StatusId를 기준으로 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 주문 상태 데이터 변경 시간입니다.

매개 변수

Name 키 필수 형식 Description
excludeFormData
 excludeFormData boolean

true이면 FieldValues는 항상 빈 배열이 됩니다.

반환

몸
CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

주문 설문 조사

작업 ID:
OrderController_Poll

Orders API 폴링 엔드포인트를 사용하면 애플리케이션이 최근 주문 변경 내용을 지속적으로 폴링하고 처리할 수 있습니다.

통합:

이 엔드포인트는 Microsoft Flow를 폴링 트리거 통합으로 사용하여 기본으로 작동하도록 설계되었습니다. 또는 모든 언어를 사용하여 사용자 지정 통합을 개발할 수 있습니다.

사용법:

일반적인 시나리오에서 이 엔드포인트에 대한 첫 번째 요청은 매개 변수를 제공하지 않아야 합니다. 두 가지(2) 가능한 성공적인 응답이 있습니다.

  • HTTP 응답 코드 200 - 최근에 변경된 주문이 있습니다. 응답 본문은 주문 데이터를 표시합니다.
  • HTTP 응답 코드 202 - 최근에 변경된 주문이 없습니다. 응답 본문은 비어 있습니다.

두 경우 모두 응답에 두 개의 중요한 헤더가 있습니다.

  • 위치 - 다음 요청의 URL입니다.
  • Retry-After - 다음 요청에 권장되는 시간 간격(초)입니다. 예를 들어 검색할 데이터가 있는 경우 Retry-After 헤더의 값은 1 또는 60입니다. 검색할 데이터가 없으면 Retry-After 헤더의 값은 300이 됩니다.

참고: 이러한 값은 권장되는 값일 뿐입니다. 애플리케이션은 요구 사항에 따라 다른 빈도로 폴링하도록 선택할 수 있습니다. 첫 번째 요청 후 모든 후속 요청은 가장 최근 응답의 위치 헤더에 제공된 URL을 사용해야 합니다. 요청에서 순서 변경 내용이 누락되지 않도록 하는 데 필요한 매개 변수가 이미 포함되어 있으므로 URL에 매개 변수를 더 추가하지 마세요.

결과는 ModifiedUtc 및 OrderId에 따라 자동으로 오름차순으로 정렬됩니다. 정렬 매개 변수는 구성할 수 없습니다.

ModifiedUtc 정의: 내부 시간 태그 = 최신 주문 데이터 변경 시간입니다.

매개 변수

Name 키 필수 형식 Description
excludeFormData
 excludeFormData boolean

true이면 OrderFormFields는 항상 빈 배열이 됩니다.
excludeCustomFieldData
 excludeCustomFieldData boolean

true이면 CustomFields가 반환되지 않습니다.

반환

몸
CustomerAPI.Models.Order.OrderHeaderApiModel

정의

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name 경로 형식 Description
아이디
 Id string

CustomerAPI.Models.Client.ReadClientApiModel

Name 경로 형식 Description
아이디
 Id integer

클라이언트의 ID입니다.
ExternalId
 ExternalId string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
CreatedUtc
 CreatedUtc date-time

클라이언트가 만들어진 원래 시점입니다.
ModifiedUtc
 ModifiedUtc date-time

클라이언트가 업데이트된 마지막 시점입니다.
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
이름
 Name string

클라이언트의 이름입니다.
Address
 Address CustomerAPI.Models.LocationApiModel
연락처
 Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name 경로 형식 Description
FieldIndex
 FieldIndex integer

필드 인덱스입니다.
캡션
 Caption string

필드 캡션입니다.
데이터 유형
 DataType integer

필드 데이터 형식입니다.
DateTimeFormat
 DateTimeFormat integer

DateTime 형식입니다.
가치
 Value

필드 값입니다.

CustomerAPI.Models.LocationApiModel

Name 경로 형식 Description
LatLon
 LatLon System.Nullable_1_Actsoft.Core.Geo.LatLon_
주소 줄 1
 AddressLine1 string

이 LocationApiModel의 AddressLine1입니다.
AddressLine2
 AddressLine2 string

이 LocationApiModel의 AddressLine2입니다.
도시
 City string

City of the LocationApiModel.
지역명
 RegionName string

LocationApiModel의 지역 이름입니다.
우편번호
 PostalCode string

LocationApiModel의 우편 번호입니다.
국가 코드
 CountryCode string

ISO 3166-1 alpha-2 코드입니다.
SubRegionName
 SubRegionName string

LocationApiModel의 SubRegion입니다.
SubRegionCode
 SubRegionCode string

LocationApiModel의 SubRegion 코드입니다.
RegionCode
 RegionCode string

LocationApiModel의 지역 코드입니다.

CustomerAPI.Models.Client.ContactApiModel

Name 경로 형식 Description
이름
 Name string

ContactApiModel의 이름입니다.
전화번호
 PhoneNumber string

ContactApiModel의 PhoneNumber입니다.
전자 메일
 Email string

ContactApiModel의 전자 메일입니다.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name 경로 형식 Description
위도
 Latitude double
경도
 Longitude double

CustomerAPI.Models.ReturnIdApiModel

Name 경로 형식 Description
아이디
 Id integer

개체 ID입니다.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

사용자 지정 목록 정의 목록 항목 API 모델을 정의합니다.

Name 경로 형식 Description
CustomListId
 CustomListId integer

사용자 지정 목록 ID입니다.
이름
 Name string

사용자 지정 목록 이름입니다.
버전
 Version string

사용자 지정 목록 버전입니다.

CustomerAPI.Models.CustomLists.CustomListApiModel

사용자 지정 목록 모델입니다.

Name 경로 형식 Description
CustomListId
 CustomListId integer

사용자 지정 목록 ID입니다.
이름
 Name string

사용자 지정 목록 이름입니다.
버전
 Version string

사용자 지정 목록 버전입니다.
Definition
 Definition CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

사용자 지정 목록 정의 API 모델을 정의합니다.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

사용자 지정 목록 정의 API 모델을 정의합니다.

Name 경로 형식 Description
칼럼
 Columns array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

사용자 지정 목록 열
UniqueColumnIndexIndex
 UniqueColumnIndexIndex integer

고유 열 인덱스입니다.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

사용자 지정 목록 정의 열 API 모델을 정의합니다.

Name 경로 형식 Description
Index
 Index integer

열 인덱스입니다.
데이터 유형
 DataType integer

열 DataType(텍스트: 0, 숫자: 1, 날짜: 2, 시간: 3, DateTime: 4, 전자 메일: 5).
이름
 Name string

열 이름입니다.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

사용자 지정 목록 열 데이터 배열에 대한 컨테이너입니다.

Name 경로 형식 Description
ColumnValues
 ColumnValues array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

데이터가 있는 열의 배열입니다.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

이 모델은 사용자 지정 목록 열 값을 정의합니다.

Name 경로 형식 Description
ColumnIndex
 ColumnIndex integer

사용자 지정 목록 열 인덱스입니다.
캡션
 Caption string

사용자 지정 목록 열 캡션입니다.
가치
 Value

사용자 지정 목록 열 값입니다.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

사용자 지정 이벤트 정의 모델입니다.

Name 경로 형식 Description
아이디
 Id string
이름
 Name string
ReverseGeocode
 ReverseGeocode boolean
매개 변수
 Parameters array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name 경로 형식 Description
이름
 Name string
유형
 Type integer
캡션
 Caption string
필수
 Required boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name 경로 형식 Description
EventId
 EventId integer

이벤트 ID입니다.
이벤트 유형
 EventType integer
EventCode
 EventCode string

이벤트 코드입니다.
EventTime
 EventTime date-time

로컬 및 오프셋이 있는 ISO 형식입니다.
사용자
 User CustomerAPI.Models.UserReferenceApiModel
차
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle
 UserLinkedToVehicle boolean

사용하도록 설정하면 이벤트의 차량에 사용자가 할당됩니다.
위치
 Location CustomerAPI.Models.LocationApiModel
PrimaryGeofence
 PrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId
 CustomEventDefinitionId string

외부 이벤트 정의 ID입니다.
EventParams
 EventParams object

이벤트 매개 변수입니다.

CustomerAPI.Models.UserReferenceApiModel

Name 경로 형식 Description
UserId
 UserId integer

사용자의 UserId입니다.
이름 (FirstName)
 FirstName string

사용자의 이름입니다.
성씨
 LastName string

사용자의 성입니다.
직원번호
 EmployeeNumber string

사용자의 직원 번호입니다.
GroupName
 GroupName string

사용자에게 할당된 그룹의 이름입니다.

CustomerAPI.Models.ReadVehicleApiModel

Name 경로 형식 Description
VehicleId
 VehicleId integer

BaseVehicleApiModel의 ID입니다.
이름
 Name string

BaseVehicleApiModel의 이름입니다.
VIN(VIN)
 VIN string

BaseVehicleApiModel의 차량 식별 번호입니다.
디바이스명
 DeviceName string

BaseVehicleApiModel과 연결된 GpsDeviceDto의 이름입니다.
시리얼 번호
 SerialNumber string

BaseVehicleApiModel의 SerialNumber입니다.
GroupName
 GroupName string

BaseVehicleApiModel의 GroupName입니다.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name 경로 형식 Description
GeofenceId
 GeofenceId integer

지오펜스의 ID입니다.
이름
 Name string

지오펜스의 이름입니다.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name 경로 형식 Description
구독아이디
 SubscriptionId string

WebHookSubscriptionResultApiModel의 ID입니다.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name 경로 형식 Description
구독아이디
 SubscriptionId string
웹 주소
 Url string
상태
 Status integer

구독 상태 - (실행 중: 1, 중지됨: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name 경로 형식 Description
아이디
 Id integer

이 StandaloneFormApiModel과 연결된 ID - (레거시 주석: FormHeaderId).
FormId
 FormId integer

이 StandaloneFormApiModel에서 참조하는 양식의 ID입니다.
FormName
 FormName string

이 StandaloneFormApiModel에서 참조하는 양식의 이름입니다.
EntryNumber
 EntryNumber string

양식 데이터 입력 번호입니다.
검토
 Reviewed boolean

이 독립 실행형FormApiModel 검토의 상태입니다.
사용자
 User CustomerAPI.Models.UserReferenceApiModel
SubmittedTime
 SubmittedTime date-time

StandaloneFormApiModel이 제출된 시점입니다.
StartTime
 StartTime date-time

StandaloneFormApiModel이 시작된 시점입니다.
SubmittedLocation
 SubmittedLocation CustomerAPI.Models.LocationApiModel
FormData
 FormData array of CustomerAPI.Models.Forms.FormFieldDataApiModel

이 StandaloneFormApiModel과 연결된 필드 목록입니다.
ApiModuleId
 ApiModuleId string

이 StandaloneFormApiModel과 연결된 ApiModule의 ID입니다.
SharedUrl
 SharedUrl string

이 StandaloneFormApiModel의 공유 URL입니다.
ReviewedByUser
 ReviewedByUser CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime
 ReviewedByTime date-time

양식 검토 시간

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name 경로 형식 Description
반복 가능
 Repeatables array of array
items
 Repeatables array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
아이디
 Id string

FormFieldDataApiModel의 ID입니다.
가치
 Value

FormFieldDataApiModel의 값입니다.
DisplayValue
 DisplayValue

FormFieldDataApiModel의 DisplayValue입니다.
CapturedTime
 CapturedTime date-time

FormFieldDataApiModel의 지정 시간 값이 캡처되었습니다.
CapturedLocation
 CapturedLocation CustomerAPI.Models.LocationApiModel
캡션
 Caption string

FormFieldDataApiModel의 캡션 콘텐츠입니다.
ApiFieldId
 ApiFieldId string

FormFieldDataApiModel의 ApiField ID입니다.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name 경로 형식 Description
아이디
 Id string

FormFieldDataApiModel의 ID입니다.
가치
 Value

FormFieldDataApiModel의 값입니다.
DisplayValue
 DisplayValue

FormFieldDataApiModel의 DisplayValue입니다.
CapturedTime
 CapturedTime date-time

FormFieldDataApiModel의 지정 시간 값이 캡처되었습니다.
CapturedLocation
 CapturedLocation CustomerAPI.Models.LocationApiModel
캡션
 Caption string

FormFieldDataApiModel의 캡션 콘텐츠입니다.
ApiFieldId
 ApiFieldId string

FormFieldDataApiModel의 ApiField ID입니다.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name 경로 형식 Description
GeofenceId
 GeofenceId integer

GeofenceApiModel의 GeofenceId입니다.
CreatedUtc
 CreatedUtc date-time

GeofenceApiModel의 CreatedUtc입니다.
ModifiedUtc
 ModifiedUtc date-time

GeofenceApiModel의 ModifiedUtc입니다.
GroupNames
 GroupNames array of string

GeofenceApiModel의 GroupPaths입니다.
이름
 Name string

GeofenceApiModelBase의 이름입니다.
유형
 Type string

GeofenceApiModel의 형식입니다.
Shape
 Shape integer

도형: 원의 경우 0, 다각형의 경우 1입니다.
Address
 Address CustomerAPI.Models.LocationApiModel
Radius
 Radius double

GeofenceApiModel의 반지름입니다.
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel의 UseGeofenceAddress입니다.

Actsoft.Core.Geo.LatLon

Name 경로 형식 Description
위도
 Latitude double
경도
 Longitude double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name 경로 형식 Description
GeofenceId
 GeofenceId integer

GeofenceApiModel의 GeofenceId입니다.
CreatedUtc
 CreatedUtc date-time

GeofenceApiModel의 CreatedUtc입니다.
ModifiedUtc
 ModifiedUtc date-time

GeofenceApiModel의 ModifiedUtc입니다.
GroupNames
 GroupNames array of string

GeofenceApiModel의 GroupPaths입니다.
Polygon
 Polygon array of Actsoft.Core.Geo.LatLon

다각형 점. 셰이프가 1이면 채워야 합니다.
이름
 Name string

GeofenceApiModelBase의 이름입니다.
유형
 Type string

GeofenceApiModel의 형식입니다.
Shape
 Shape integer

도형: 원의 경우 0, 다각형의 경우 1입니다.
Address
 Address CustomerAPI.Models.LocationApiModel
Radius
 Radius double

GeofenceApiModel의 반지름입니다.
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel의 UseGeofenceAddress입니다.

CustomerAPI.Models.Order.OrderListItemApiModel

Name 경로 형식 Description
주문ID
 OrderId integer

OrderBaseApiModel의 ID입니다.
ExternalOrderId
 ExternalOrderId string

클라이언트 - API 확장 속성에 대한 외부 사용 OrderId입니다.
마감일
 DueDate date-time

이 OrderBaseApiModel이 완료될 예정입니다(v1.3에서는 사용되지 않음).
StartTime
 StartTime date-time

이 OrderBaseApiModel이 시작되어야 하는 시점(v1.3에 도입됨).
EndTime
 EndTime date-time

이 OrderBaseApiModel이 완료될 예정입니다(v1.3에 도입됨).
ServiceType
 ServiceType string

이 OrderBaseApiModel과 연결된 ServiceType입니다.
CreatedUTCDate
 CreatedUTCDate date-time

이 OrderBaseApiModel이 만들어진 시점입니다.
주문 번호
 OrderNumber string

이 OrderBaseApiModel과 연결된 주문 번호입니다.
IsClosed
 IsClosed boolean

OrderBaseApiModel이 닫혔는지를 보여 주는 상태입니다.
상태
 Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
 ExternalClientId string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
ClientId
 ClientId integer

클라이언트 - API 확장 속성에 대한 내부 사용 ID입니다.
클라이언트
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

이 OrderBaseApiModel과 연결된 ApiService의 ID입니다.
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

사용자 지정 필드 모듈 버전입니다.
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
 Recurrence boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name 경로 형식 Description
StatusIndex
 StatusIndex integer

OrderStatusApiModel의 인덱스입니다.
상태 유형
 StatusType integer

주문 상태: 새 주문의 경우 0, 디스패치된 경우 1개, 진행 중인 경우 2개, 완료 3개, 취소된 경우 4개.
StatusLabel
 StatusLabel string

OrderStatusApiModel의 콘텐츠에 레이블을 지정합니다.
StatusId
 StatusId integer

OrderStatusApiModel의 ID입니다.
StatusStartDateTime
 StatusStartDateTime date-time

OrderStatusApiModel 시작 시점입니다.
사용자
 User CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Name 경로 형식 Description
GroupNames
 GroupNames array of string

클라이언트 그룹 계층 이름입니다.
이름
 Name string

클라이언트의 이름입니다.
Address
 Address CustomerAPI.Models.LocationApiModel
연락처
 Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name 경로 형식 Description
StatusHistory
 StatusHistory array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

이 OrderApiModel과 연결된 OrderStatusListItems 목록입니다.
OrderFormFields
 OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
주문ID
 OrderId integer

OrderBaseApiModel의 ID입니다.
ExternalOrderId
 ExternalOrderId string

클라이언트 - API 확장 속성에 대한 외부 사용 OrderId입니다.
마감일
 DueDate date-time

이 OrderBaseApiModel이 완료될 예정입니다(v1.3에서는 사용되지 않음).
StartTime
 StartTime date-time

이 OrderBaseApiModel이 시작되어야 하는 시점(v1.3에 도입됨).
EndTime
 EndTime date-time

이 OrderBaseApiModel이 완료될 예정입니다(v1.3에 도입됨).
ServiceType
 ServiceType string

이 OrderBaseApiModel과 연결된 ServiceType입니다.
CreatedUTCDate
 CreatedUTCDate date-time

이 OrderBaseApiModel이 만들어진 시점입니다.
주문 번호
 OrderNumber string

이 OrderBaseApiModel과 연결된 주문 번호입니다.
IsClosed
 IsClosed boolean

OrderBaseApiModel이 닫혔는지를 보여 주는 상태입니다.
상태
 Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
 ExternalClientId string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
ClientId
 ClientId integer

클라이언트 - API 확장 속성에 대한 내부 사용 ID입니다.
클라이언트
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

이 OrderBaseApiModel과 연결된 ApiService의 ID입니다.
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

사용자 지정 필드 모듈 버전입니다.
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
 Recurrence boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name 경로 형식 Description
StatusStartDateTime
 StatusStartDateTime date-time

이 OrderStatusHistoryListItemApiModel 상태가 시작된 시점입니다.
StatusEndDateTime
 StatusEndDateTime date-time

이 OrderStatusHistoryListItemApiModel 상태가 종료된 시점입니다.
StatusId
 StatusId integer

이 OrderStatusHistoryListItemApiModel과 연결된 ID입니다.
StatusIndex
 StatusIndex integer

이 OrderStatusHistoryListItemApiModel과 연결된 인덱스입니다.
StatusLabel
 StatusLabel string

이 OrderStatusHistoryListItemApiModel과 연결된 레이블 콘텐츠입니다.
상태 유형
 StatusType integer

주문 상태: 새 주문의 경우 0, 디스패치된 경우 1개, 진행 중인 경우 2개, 완료 3개, 취소된 경우 4개.
ExternalOrderId
 ExternalOrderId string

클라이언트 - API 확장 속성에 대한 외부 사용 OrderId입니다.
주문ID
 OrderId integer

이 OrderStatusHistoryListItemApiModel과 연결된 OrderId입니다.
사용자
 User CustomerAPI.Models.UserReferenceApiModel
StartAddress
 StartAddress CustomerAPI.Models.LocationApiModel
EndAddress
 EndAddress CustomerAPI.Models.LocationApiModel
ApiServiceId
 ApiServiceId string

이 OrderStatusHistoryListItemApiModel과 연결된 ApiService의 ID입니다.
FieldValues
 FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name 경로 형식 Description
OrderFormFields
 OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
주문ID
 OrderId integer

OrderBaseApiModel의 ID입니다.
ExternalOrderId
 ExternalOrderId string

클라이언트 - API 확장 속성에 대한 외부 사용 OrderId입니다.
마감일
 DueDate date-time

이 OrderBaseApiModel이 완료될 예정입니다(v1.3에서는 사용되지 않음).
StartTime
 StartTime date-time

이 OrderBaseApiModel이 시작되어야 하는 시점(v1.3에 도입됨).
EndTime
 EndTime date-time

이 OrderBaseApiModel이 완료될 예정입니다(v1.3에 도입됨).
ServiceType
 ServiceType string

이 OrderBaseApiModel과 연결된 ServiceType입니다.
CreatedUTCDate
 CreatedUTCDate date-time

이 OrderBaseApiModel이 만들어진 시점입니다.
주문 번호
 OrderNumber string

이 OrderBaseApiModel과 연결된 주문 번호입니다.
IsClosed
 IsClosed boolean

OrderBaseApiModel이 닫혔는지를 보여 주는 상태입니다.
상태
 Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
 ExternalClientId string

클라이언트 - API 확장 속성에 대한 외부 사용 ID입니다.
ClientId
 ClientId integer

클라이언트 - API 확장 속성에 대한 내부 사용 ID입니다.
클라이언트
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

이 OrderBaseApiModel과 연결된 ApiService의 ID입니다.
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

사용자 지정 필드 모듈 버전입니다.
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
 Recurrence boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name 경로 형식 Description
아이디
 Id integer

Timekeeping 항목의 ID(레거시 주석: RootSubmittedStatusId).
사용자
 User CustomerAPI.Models.UserReferenceApiModel
ClockInTime
 ClockInTime date-time

사용자가 시스템에 클럭된 시점입니다.
ClockInLocation
 ClockInLocation CustomerAPI.Models.LocationApiModel
ClockOutTime
 ClockOutTime date-time

사용자가 시스템에서 클록된 시점입니다.
ClockOutLocation
 ClockOutLocation CustomerAPI.Models.LocationApiModel
TotalHours
 TotalHours double

이 Timekeeping 항목의 총 시간 수입니다.
TotalBreakHours
 TotalBreakHours double

이 시간 정리 항목의 총 휴식 시간(비근무 시간)입니다.
NetHours
 NetHours double

이 Timekeeping 항목에 대해 청구할 수 있는 총 시간 수입니다.
승인됨
 Approved boolean

이 시간 보관 항목에 대한 감독자 승인 상태입니다.
중단 or 휴식
 Breaks array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData
 ClockInFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData
 ClockOutFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion
 ModuleVersion System.Version
CompanyModuleId
 CompanyModuleId integer

이 Timekeeping 항목을 제출하는 데 사용되는 회사 모듈의 ID입니다.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name 경로 형식 Description
아이디
 Id integer

SubmittedStatusId.
StartTime
 StartTime date-time

시작 시간입니다.
StartLocation
 StartLocation CustomerAPI.Models.LocationApiModel
EndTime
 EndTime date-time

종료 시간입니다.
EndLocation
 EndLocation CustomerAPI.Models.LocationApiModel
DurationHours
 DurationHours double

기간(시간)입니다. EndTime이 null인 경우 null일 수 있습니다.
상태 유형
 StatusType integer

상태 유형: 휴식의 경우 1, 점심에는 2입니다.
StartLabel
 StartLabel string

레이블을 시작합니다.
EndLabel
 EndLabel string

끝 레이블입니다.
캡션
 Caption string

캡션.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Name 경로 형식 Description
CompanyModuleId
 CompanyModuleId integer
ModuleVersion
 ModuleVersion System.Version
FieldValues
 FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Name 경로 형식 Description
_전공
 _Major integer
_사소한
 _Minor integer
_체격
 _Build integer
_개정판
 _Revision integer

CustomerAPI.Models.Tracking.TripApiModel

Name 경로 형식 Description
사용자
 User CustomerAPI.Models.UserReferenceApiModel
차
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
StartTime
 StartTime date-time

이 TripApiModel 상태가 시작된 시점입니다.
EndTime
 EndTime date-time

이 TripApiModel 상태가 종료된 시점입니다.
StartLocation
 StartLocation CustomerAPI.Models.LocationApiModel
EndLocation
 EndLocation CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence
 StartPrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence
 EndPrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime
 TotalStopTime double

이 TripApiModel과 연결된 시간 단위의 중지 시간입니다.
TotalIdleTime
 TotalIdleTime double

이 TripApiModel과 연결된 유휴 시간(시간)입니다.
TotalDuration
 TotalDuration double

이 TripApiModel과 관련된 전체 시간(시간)입니다.
거리
 Distance double

이 TripApiModel과 연결된 지역화된 단위로 이동한 거리입니다.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name 경로 형식 Description
레코드
 Records array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
계속 토큰
 ContinuationToken string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name 경로 형식 Description
사용자
 User CustomerAPI.Models.UserReferenceApiModel
차
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
TimeTag
 TimeTag date-time

이 GpsDataRecordApiModel과 연결된 TimeTag입니다.
위치
 Location System.Nullable_1_Actsoft.Core.Geo.LatLon_
지오펜스
 Geofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
속도
 Speed double

이 GpsDataRecordApiModel과 관련된 이동 속도입니다.
Heading
 Heading double

이 GpsDataRecordApiModel과 연결된 도의 나침반 방향입니다.
상태
 Status integer

OrderBaseApiModel과 연결된 ApiMovementStatus - (중지됨: 1, 유휴: 2, 이동: 3, NotTracking: 4) : OrderStatusApiModel.
상태시간
 StatusTime string

이 GpsDataRecordApiModel 상태가 설정된 시점입니다.
거리
 Distance double

이 TripApiModel과 연결된 지역화된 단위로 이동한 거리입니다.
IgnitionOn
 IgnitionOn boolean

이 GpsDataRecordApiModel과 관련된 차량 점화의 상태입니다.
LocationProvider
 LocationProvider integer

이 GpsDataRecordApiModel과 연결된 API 위치 공급자 - (GPS: 1, 네트워크: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name 경로 형식 Description
사용자 이름
 UserName string

사용자의 UserName입니다.
UserId
 UserId integer

사용자의 ID 값입니다.
GroupName
 GroupName string

사용자 그룹의 이름입니다.
이름 (FirstName)
 FirstName string

사용자의 이름입니다.
성씨
 LastName string

사용자의 성입니다.
직원번호
 EmployeeNumber string

사용자의 직원 번호입니다.
전자 메일
 Email string

사용자의 전자 메일 주소입니다.
Phone
 Phone string

사용자의 전화 번호입니다.
RoleId
 RoleId integer

사용자의 RoleId - (Admin: 1, User: 3, Power User: 5).
IsActive
 IsActive boolean

사용자의 활성 상태입니다.
EPTTEnabled
 EPTTEnabled boolean

사용자에 대한 향상된 푸시 투 토크 기능의 상태: 부울.
EPTTNumber
 EPTTNumber string

사용자용 향상된 통화 푸시-투-토크 기능의 전화 번호: 문자열입니다.
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 전화 번호 - Kodiak에서 제공합니다.
EPTTToken
 EPTTToken string

Kodiak에서 제공하는 Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 API 토큰입니다.
GPSEnabled
 GPSEnabled boolean

사용자의 GPS 기능 상태입니다.
MobileOnly
 MobileOnly boolean

CAB에 대한 데스크톱 웹 애플리케이션 액세스 상태 - (WebApp Access 없음: True, 전체 앱 액세스: False).
LicenseType
 LicenseType integer

사용자에게 할당된 라이선스 유형: - 정의되지 않은 경우 0, 정규용 1개, WebOnly의 경우 2, 직원의 경우 3입니다.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name 경로 형식 Description
UserId
 UserId integer

사용자의 ID 값입니다.
이름 (FirstName)
 FirstName string

사용자의 이름입니다.
성씨
 LastName string

사용자의 성입니다.
직원번호
 EmployeeNumber string

사용자의 직원 번호입니다.
전자 메일
 Email string

사용자의 전자 메일 주소입니다.
Phone
 Phone string

사용자의 전화 번호입니다.
RoleId
 RoleId integer

사용자의 RoleId - (Admin: 1, User: 3, Power User: 5).
IsActive
 IsActive boolean

사용자의 활성 상태입니다.
EPTTEnabled
 EPTTEnabled boolean

사용자에 대한 향상된 푸시 투 토크 기능의 상태: 부울.
EPTTNumber
 EPTTNumber string

사용자용 향상된 통화 푸시-투-토크 기능의 전화 번호: 문자열입니다.
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 전화 번호 - Kodiak에서 제공합니다.
EPTTToken
 EPTTToken string

Kodiak에서 제공하는 Kodiak EPTT 시스템에 사용자를 인증하는 데 사용되는 API 토큰입니다.
GPSEnabled
 GPSEnabled boolean

사용자의 GPS 기능 상태입니다.
MobileOnly
 MobileOnly boolean

CAB에 대한 데스크톱 웹 애플리케이션 액세스 상태 - (WebApp Access 없음: True, 전체 앱 액세스: False).
LicenseType
 LicenseType integer

사용자에게 할당된 라이선스 유형: - 정의되지 않은 경우 0, 정규용 1개, WebOnly의 경우 2, 직원의 경우 3입니다.

CustomerAPI.Models.Vehicles.VehicleReadApi

차량 데이터 모델.

Name 경로 형식 Description
InternalId
 InternalId integer
Number
 Number string
이름
 Name string
유형
 Type string
Tag
 Tag string
UserEmployeeNumber
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
만들다
 Make string
연도
 Year integer
Model
 Model string
색깔
 Color string
VIN(VIN)
 VIN string
IsActive
 IsActive boolean
디바이스 유형
 DeviceType integer
DeviceSerialNumber
 DeviceSerialNumber string

integer

기본 데이터 형식 '정수'입니다.

객체

이것은 '객체' 유형입니다.